API · Webhooks

Update Webhook

Update a webhook (requires full access).

PATCH/webhooks/{webhook_id}Full access

Request parameters

Parameter	Type	Description
`webhook_id` path · required	`string`	The Webhook ID.
`endpoint` body · optional	`string`	Public HTTPS URL that receives webhook events; private hosts are not allowed.
`events` body · optional	`(string)[]` At least 1 item	Array of event types to subscribe to.
`status` body · optional	`"enabled" \| "disabled"`	The status of the webhook.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X PATCH "$OPENSEND_BASE_URL/webhooks/YOUR_webhook_id" \
  -H "Authorization: Bearer $OPENSEND_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"status":"disabled"}'

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "object": "webhook",
  "id": "479e3145-dd38-476b-932c-529ceb705947"
}

Behavior and errors

Set status to enabled or disabled. Re-enable a failing endpoint after correcting its receiver. See retries and replays.

Use a full-access credential. Unknown or foreign resources return 404. See authentication, errors, rate limits, and pagination.