Webhooks

Get webhook subscriptions

Returns existing webhook subscriptions.

get/webhooks

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/webhooks
  • Auth
    API key in header x-api-key and API key in header Authorization

Query parameters

Offsetinteger
Limitinteger

Response

When request is successful. Returns existing webhook subscriptions.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
offsetinteger nullable
limitinteger nullable
sizeinteger

Example response

{
  "value": [
    {
      "accountId": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
      "name": "Listen to matter and contact changes",
      "eventTypes": [
        "matter.updated",
        "contact.created"
      ],
      "eventNotificationUrl": "http://yourdomain.com/notify",
      "createdDateUtc": "2022-04-23T14:00:00Z",
      "updatedDateUtc": "2022-04-23T14:00:00Z",
      "lastUpdated": 637847425252027400
    }
  ]
}

Changes

No recorded changes to this operation across all 15 revisions of this API.