Webhooks

Update a webhook

Update a webhook subscription's URL or subscribed event types. The signing secret is unchanged.

Authentication

x-api-keystring

Your Living Brain API key. Create one from the dashboard; keys are scoped to an organization and carry the role of the member they were issued to.

Path parameters

idstringRequired
Webhook subscription id

Headers

x-subject-idstringRequired
Identifies the end user the request is made on behalf of. Brains are owned by a subject, so this determines which brains the caller can see.

Request

This endpoint expects an object.
urlstringOptional
New delivery URL. Omit to leave unchanged.
eventslist of enumsOptional
New event list. Replaces the existing subscription set. Omit to leave unchanged.
activebooleanOptional
Set false to pause deliveries without deleting the subscription.

Response

idstring
Subscription id
tenantIdstring
Owning tenant id
urlstring
Delivery endpoint
eventslist of enums

Subscribed event types; empty = all

activeboolean
Whether the subscription is currently receiving deliveries.
createdAtdatetime
ISO 8601 timestamp of when this record was created.
updatedAtdatetime
ISO 8601 timestamp of when this record was last modified.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error