Skip to main content
POST
Register a notification webhook

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

org_id
string<uuid>
required

The organization ID of the user's organization

Body

application/json

Register a webhook: an https endpoint URL and the topics it subscribes to. Topics are validated against the catalogue — an unknown topic is rejected.

url
string
required
topics
enum<string>[]
Available options:
device.action_required,
device.information

Response

201 - application/json

Created

The response to a create: the new webhook plus its signing secret. The secret is returned once, here only — it is never retrievable again, so the caller must store it now.

webhook_id
string<uuid>
required
url
string
required
enabled
boolean
required
topics
enum<string>[]
required
Available options:
device.action_required,
device.information
signing_secret
string
required