observe_webhooks_update
Edit a registered endpoint: its url, its description, or whether it is active.
Edit a registered endpoint: its url, its description, or whether it is active. Setting active to false keeps the registration and stops delivery. Omit a field to leave it alone; pass null to clear the description. The signing secret is not editable here — rotate it instead.
Behavior
- HTTP
PATCH /observe/webhooks/:id
Arguments
Name | Type | Required | Description |
|---|---|---|---|
id | string | • | Identifier of the endpoint to change |
url | string | — | New HTTPS endpoint. Plain http:// is rejected |
active | boolean | — | false keeps the registration and stops delivery; true resumes it |
description | string | — | New note, or null to clear it |
Response
Field | Type | Always | Description |
|---|---|---|---|
id | string | • | Identifier of the endpoint |
url | string | • | HTTPS endpoint events are POSTed to |
active | boolean | • | Whether deliveries are being attempted for it |
createdAt | string | • | ISO 8601 registration timestamp |
updatedAt | string | • | ISO 8601 timestamp of the last change |
description | string | • | Free-form note given at registration, or null |
Try it
Edit a registered endpoint: its url, its description, or whether it is active.