Skip to main content
POST
Add a webhook endpoint

Authorizations

Authorization
string
header
required

A team key: sk_test_ for sandbox, sk_live_ for production.

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
url
string<uri>
required
Maximum string length: 2048
events
enum<string>[]
required
Required array length: 1 - 10 elements
Available options:
char.ready,
char.failed,
char.updated,
license.issued,
license.revoked,
license.expired,
license.updated,
license.redeemed,
usage.generated,
usage.blocked
env
enum<string>
Available options:
production,
sandbox
auth
object

Response

201 - application/json

Default Response

endpoint
object
required
secret
string
required