Skip to Content
SendlySendly
API ReferenceWebhooks

Update a webhook

PATCH
/api/v1/webhooks/{id}

Partial update. Omitted fields are left alone.

event_types REPLACES the stored subscription list rather than merging into it, so an event you omit is unsubscribed. Setting status back to ACTIVE from DISABLED also clears the consecutive-failure counter, so an auto-disabled endpoint gets a clean slate.

The signing secret is untouched by an update, and is not part of this response.

Requires the webhooks:write scope — Create, edit, and delete your webhook endpoints.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

id*string

Resource id.

Formatuuid
application/json
  1. body

Body for PATCH /api/v1/webhooks/{id}.

url?string
Formaturi
event_types?array<>
Items1 <= items
status?string
Value in"ACTIVE""PAUSED""DISABLED"

Response Body

The updated webhook

application/json
  1. response

A webhook endpoint as exposed on the v1 API. The signing secret is NEVER on this shape — it is returned once, by create and by rotate, and no endpoint reads it back.

id*string
Formatuuid
url*string
event_types*array<string>
status*string
Value in"ACTIVE""PAUSED""DISABLED"
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
Example Request
curl -X PATCH 'https://api.sendly.now/api/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "url": "string",  "event_types": [    "string"  ],  "status": "ACTIVE",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}