Skip to main content
POST
Create a webhook registration

Authorizations

x-api-key
string
header
required

Path Parameters

type
enum<string>
required

Type of webhook to be created.

Available options:
orders,
bank-accounts,
users

Body

application/json
url
string
required

URL to send the webhook to

userId
string

The user ID of the user that the webhook is being created for

Example:

"66290ac8bd3903485989f82e"

retryOnFailure
boolean

Whether to retry webhook delivery on failure. If true, the system will retry up to 5 times with exponential backoff. If false or not provided, only one attempt will be made.

Example:

true

Response

201 - application/json

Created

id
string

Id of the created webhook

Example:

"66733d33222710ab2785dc62"

secret
string

Webhook secret

Example:

"IgAeeIIorKQ86gAGItsmY0slzhxRY1Gvj/VIJz8DtIs="