Sign in

v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB
Webhook Notifications

Create webhook endpoint

Permissions required: Configure Webhooks

Create a new endpoint where you would like to receive webhook notifications.

post/webhook/endpoints

Request body

descriptionstring
publicKeystring
urlstring uri required

url of the endpoint, requires http:// prefix

Example request

[
  {
    "url": "https://your-domain.com/transaction-webhooks",
    "description": "Endpoint for receiving transaction event webhooks",
    "subscriptions": [
      {
        "eventTypeId": "withdrawal.initiated"
      }
    ],
    "publicKey": "----BEGIN PUBLIC KEY-----\nMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEeg+pxTCsjew/+7IK4+Vw5zyHDnMW7bzn\nsClhuYIKjXF8EJ1lfyZC2VPVullBKgvHRzNMfC1KkF2LIoRp2ibcWQ==\n-----END PUBLIC KEY-----"
  }
]

Response

Created webhook endpoint ids

datastring[] required