Create Webhook

POST /webhooks

Registers a new webhook. By default, organizations are limited to creating 5 webhooks.

• User action signature required. See User Action Signing for more information.

• Request headers required. See Request Headers for more information.

• Authentication required. See Authentication Headers for more information.

Permissions Required

• Webhooks:Create

Request Body

{
  "url": "https://example.com/my/webhook/endpoint",
  "description": "My awesome webhook, it's so great", // optional
  "status": "Enabled" // optional
  "events": [                             
    "wallet.transfer.initiated",
    "wallet.transfer.executed",
    "wallet.transfer.confirmed",
  ],

}

Property	Type - Optional	Description
url	String - Required	The webhook endpoint url where events will be pushed. The url needs to be a valid http / https url.
description	String - Optional	Description of what the endpoint is for.
status	String - Optional	Possible values: Enabled | Disabled. If webhook status is Disabled, no event will be pushed to the webhook endpoint. If status is not specified, default status is Enabled.
events	String List - Required	List of supported events the webhook subscribes to (see full list here). You can also subscribe to all events by passing events: ["*"].

Response

{
  "id": "wh-xxx-xxxxxxx",
  "url": "https://example.com/my/webhook/endpoint",
  "events": [
    "wallet.transfer.initiated",
    "wallet.transfer.executed",
    "wallet.transfer.confirmed",
  ],
  "description": "My awesome webhook, it's so great",
  "status": "Enabled",
  "dateCreated": "2023-11-01T08:52:01.186Z",
  "dateUpdated": "2023-11-01T08:52:01.186Z",
  "secret": "whs-Fij3kMCRZLCAzOqnpLzVQUEKe9Rw5V8s" // only included once in the creation endpoint
}

Property	Type	Description
id	String	ID of the webhook
url	String	See above
description	String - Optional	See above
status	String	See above
events	String List	See above
dateCreated	String	ISO 8601 string representing date of creation of the webhook
dateUpdated	String	ISO 8601 string representing date of update of the webhook
secret	String	Secret which can be used to verify authenticity of the message received by the webhook (more details here). The secret is only included in the "Create Webhook" response, we will never show it to you again, so you need to save it securely on your side upon webhook creation.