Skip to main content

Query Subscriptions

List Subscriptions​

GET ~/api/webhook?page=pageSize,pageStart
ParameterInRequiredDescription
pagequerynopageSize,pageStart — size first, then start. Defaults to 25,0.
Size comes first

The page parameter is a comma-separated pair in the order size, start — page=10,20 means "10 per page, starting at offset 20", not "page 10 of size 20". Both values must be present for either to take effect; a single value is ignored and the defaults apply.

Request
curl "https://{host}/{instance}/api/webhook?page=25,0" \
  -H "Authorization: Bearer <access-token>" \
  -H "Accept: application/json"

Response​

200 OK
{
  "total": 1,
  "pageSize": 25,
  "pageStart": 0,
  "_type": "WebhookSubscription",
  "results": [
    {
      "id": "336d997f-d9fa-4612-80e8-9f41a4b41352",
      "webhookId": "Webhook identifier",
      "url": "https://matchedUrl.com",
      "description": "Short description of the webhook subscription",
      "enabled": true,
      "eventTypes": [],
      "lastResponseAt": "0001-01-01T00:00:00Z",
      "retryCount": 0,
      "createdAt": "2018-09-27T20:28:41.3829451Z",
      "updatedAt": "2018-09-27T20:28:41.3829451Z",
      "createdBy": "Member:20"
    }
  ]
}
FieldDescription
totalTotal subscriptions, not the number in this page.
pageSizeThe effective page size.
pageStartThe effective offset.
_typeAlways WebhookSubscription.
resultsThe subscriptions in this page.

Page through by advancing pageStart by pageSize until you have seen total results.

Retrieve One Subscription​

GET ~/api/webhook/:id

Where :id is the server-assigned UUID from create, not your webhookId.

Request
curl "https://{host}/{instance}/api/webhook/336d997f-d9fa-4612-80e8-9f41a4b41352" \
  -H "Authorization: Bearer <access-token>" \
  -H "Accept: application/json"

The response is a single subscription object, in the same shape as one results entry above.

An unknown id returns 404 with an explanatory body:

404 Not Found
{
  "errorMessage": "Webhook subscription with id 336d997f-d9fa-4612-80e8-9f41a4b41352 was not found"
}
Undocumented in the original reference

GET ~/api/webhook/:id did not appear in the published reference material at all.

Fields Worth Watching​

Two fields make this endpoint the first place to look when a webhook has "stopped working":

  • retryCount — consecutive failed deliveries. Non-zero means deliveries are failing right now. When it reaches the instance's retry limit (default 5), the subscription is taken out of service.
  • lastResponseAt — when a delivery attempt last got a response. Still 0001-01-01T00:00:00Z after events should have fired means nothing has ever been delivered — suspect the event type definition or enabled, not the receiver.

For the detail behind those numbers, use delivery status.

Notes​

  • authorizationHeader and secret are never returned by this endpoint. They are write-only.
  • The list is not filtered to subscriptions you created; it is instance-wide, consistent with the ManageConfig privilege the API requires.
  • Recover a lost id by listing and matching on your own webhookId.