Webhooks

List webhook endpoints

Your org's registered endpoints with delivery health.

GET/v1/webhooks

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Response Body

`application/json`

cURL

curl -X GET "https://example.com/webhooks"

{
  "success": true,
  "endpoints": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "url": "string",
      "events": [
        "string"
      ],
      "enabled": true,
      "description": "string",
      "secret": "string",
      "consecutiveFailures": -9007199254740991,
      "lastDeliveryAt": "2019-08-24T14:15:22Z",
      "lastDeliveryStatus": -9007199254740991,
      "lastError": "string",
      "disabledAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "error": "unauthorized"
}

POSTRegister a webhook endpoint

GETGet a webhook endpoint

One endpoint with its delivery health.

List webhook endpoints

Authorization

Response Body

200application/json

401application/json

`application/json`

`application/json`