Update a webhook endpoint
POST/organization/webhooks/{webhook_id}/update
Changes the URL, event types, filters or description of an endpoint; send only what changes. History and the signing secret are kept, and so is the position of every event type that stays subscribed. An event type you add starts from now and does not replay listings from before the change. Removing a type drops its position, so adding it back also starts from now. New filters apply to events not yet queued. Does not re-enable a disabled endpoint: use the enable call.
- Authentication
- Send an admin key (dk_admin_…) as a Bearer token. Data keys are refused here.
- Scope
organization- Cost
- Free
Parameters
| Name | Description |
|---|---|
webhook_idrequiredType: string · path | |
Idempotency-KeyType: string · header | A unique string (a UUID is ideal) making this call safe to retry. The same key with the same body replays the first response and sets |
Request body
| Name | Description |
|---|---|
urlType: string | |
event_typesType: string[] | One of: |
filtersType: object | Which listings this endpoint wants, in the vocabulary of GET /listings. The plot filters ( |
descriptionType: string | null | Null clears it. |
Response
The data field is an object with these fields.
| Name | Description |
|---|---|
idrequiredType: string | |
urlrequiredType: string | |
event_typesrequiredType: string[] | |
filtersrequiredType: object | |
descriptionrequiredType: string | null | |
statusrequiredType: string | One of: |
disabled_reasonrequiredType: string | null |
|
consecutive_failuresrequiredType: integer | |
created_atrequiredType: string (date-time) | ISO 8601 time |
Related endpoints
- Get your organization
GET /organization - List data keys
GET /organization/keys - Create a data key
POST /organization/keys - Revoke a key
POST /organization/keys/{key_id}/revoke - List projects
GET /organization/projects - Daily usage
GET /organization/usage - List members and invitations
GET /organization/members - List audit events
GET /organization/audit-events - List request logs
GET /organization/request-logs - Create a webhook endpoint
POST /organization/webhooks - List webhook endpoints
GET /organization/webhooks - Re-enable a webhook endpoint
POST /organization/webhooks/{webhook_id}/enable - Rotate a webhook signing secret
POST /organization/webhooks/{webhook_id}/rotate-secret - Delete a webhook endpoint
POST /organization/webhooks/{webhook_id}/delete - List deliveries
GET /organization/webhooks/{webhook_id}/deliveries - Replay a delivery
POST /organization/webhooks/{webhook_id}/deliveries/{delivery_id}/replay