Skip to main content
PATCH
Update 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

webhook_id
string<uuid>
required

The webhook ID

Body

application/json

Partial update of a webhook. Only the fields present change: enabled toggles the delivery switch; topics replaces the full subscription set (an empty list clears it). The endpoint URL is immutable — delete and recreate to change it.

enabled
boolean | null
topics
enum<string>[] | null
Available options:
device.action_required,
device.information

Response

200 - application/json

OK

Partner-facing view of a registered notification webhook, read from the Webhook projection. The owning organization is implicit in the URL, and the signing secret is never exposed here — it is surfaced once at creation and on rotation and nowhere else.

webhook_id
string<uuid>
required
url
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
enabled
boolean
default:true

The webhook-level on/off switch

topics
any[]

Subscribed topics