Webhooks

Retrieve the list of registered webhooks

GET /api/v1/webhooks

Responses

200 A list of registered webhooks
application/json
webhookId string optional

The unique identifier of the webhook.

endpoint string optional

The URL of the webhook endpoint.

GET /api/v1/webhooks
GET /api/v1/webhooks HTTP/1.1
Accept: */*
200 – A list of registered webhooks
[
  {
    "webhookId": "text",
    "endpoint": "text"
  }
]

Register a new webhook endpoint

POST api/v1/webhooks

Body application/json
endpoint string · optional

The URL of the webhook endpoint to be registered.

Responses

200 Webhook registered successfully
success boolean · optional

Example: true

webhookId string · optional

The unique identifier of the registered webhook.

400 Bad request – typically means the endpoint was not provided or is invalid.
success boolean · optional

Example: false

POST /api/v1/webhooks
POST /api/v1/webhooks HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "endpoint": "text"
}
{
  "success": true,
  "webhookId": "text"
}
{
  "success": false
}