Skip to main content
POST
Send a test message to a webhook for one of its subscribed topics

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

webhook_id
string<uuid>
required

The webhook ID

Body

application/json

Send a test sample for one topic. The topic must be one the webhook is currently subscribed to.

topic
enum<string>
required
Available options:
device.action_required,
device.information

Response

200 - application/json

OK

The synchronous outcome of a test delivery. outcome is delivered (with the endpoint's HTTP status_code), failed (detail carries the transport error), or cancelled (detail says why, e.g. the webhook is disabled). The response is 200 for all three — the test ran; branch on outcome, not the HTTP status.

topic
enum<string>
required
Available options:
device.action_required,
device.information
schema_version
integer
required
outcome
string
required
status_code
integer | null
detail
string | null