Create a new webhook

Create a new webhook to receive event notifications to the specified URL. Provide a list of event types that you want to subscribe to and a URL for the webhook. Only HTTPS URLs are supported.

For more information, see the guides: About webhooks and Manage webhooks.

Request​

The webhook to create.

Request body

Body object

A valid webhook URL to which to send event notifications. The supported protocol is https.

Possible values: [TransactionCreated, TransactionStateChanged, PayoutLinkCreated, PayoutLinkStateChanged]

Default value: TransactionCreated,TransactionStateChanged

A list of event types to subscribe to. If you don't provide it, you're automatically subscribed to the default event types.

Response​

The successfully created webhook

Response body

Body object

The ID of the webhook.

The valid webhook URL that event notifications are sent to. The supported protocol is https.

Possible values: [TransactionCreated, TransactionStateChanged, PayoutLinkCreated, PayoutLinkStateChanged]

The list of event types that you are subscribed to.

The signing secret for the webhook.