Webhooks

get

Retrieve a list of webhooks.

Query parameters
Responses
200

Successfully retrieved a list of webhooks.

application/json
Responseall of
get
/webhooks
GET /webhooks HTTP/1.1
Host: 
Accept: */*
200

Successfully retrieved a list of webhooks.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "id": "87f00850-08a3-4605-b9a4-e6b624295fad",
      "eventType": "node.created",
      "url": "https://webhook.site/b3c499f1-bdb6-4005-860a-5725f57e301d"
    }
  ]
}
post

Create a new webhook. Url to be called when the event is triggered.

Body
eventTypestring · enumRequired

Event type the webhook is listening to

Example: bond.createdPossible values:
urlstringRequired

Url to be called when the event is triggered

Example: https://webhook.site/b3c499f1-bdb6-4005-860a-5725f57e301d
Responses
201

Successfully created a webhook.

application/json
post
/webhooks
POST /webhooks HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "eventType": "bond.created",
  "url": "https://webhook.site/b3c499f1-bdb6-4005-860a-5725f57e301d"
}
201

Successfully created a webhook.

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "87f00850-08a3-4605-b9a4-e6b624295fad",
  "eventType": "node.created",
  "url": "https://webhook.site/b3c499f1-bdb6-4005-860a-5725f57e301d"
}
delete
Path parameters
webhookIdstring · uuidRequired

The id of the webhook to delete.

Example: 7c43169b-0d18-467e-9a26-0fc327e01905
Responses
204

Successfully deleted the webhook.

No content
delete
/webhooks/{webhookId}
DELETE /webhooks/{webhookId} HTTP/1.1
Host: 
Accept: */*
204

Successfully deleted the webhook.

No content
PreviousTradesNextModels