v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-27107348584.3 KB
Webhooks

View Webhook

View a webhook endpoint.

get/webhooks/{id}

Response

OK

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED'

Request status code

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "id": "17bbf36498de4d68a0d4f86c7b62f69f",
    "createdAt": "2021-04-14T09:30:24Z",
    "name": "Event Notification Postback",
    "url": "https://webhook.clienturl.xyz",
    "secret": "a little secret",
    "eventTypes": [
      "ACCOUNT_CONNECTED"
    ],
    "updatedAt": "2021-04-14T09:30:24Z"
  }
}