API ReferenceWebhooks
Update a webhook
PATCH
Requires the webhooks:write scope — Create, edit, and delete your webhook endpoints.
header
AuthorizationBearer <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*stringFormat
uuidapplication/json- body
Body for PATCH /api/webhooks/{id}.
url?stringFormat
urieventTypes?array<>Items
1 <= itemsstatus?stringValue in
"ACTIVE""PAUSED""DISABLED"Webhook updated
application/json- response
Single webhook (no secret).
success*trueValue in
truedata*A user-managed outbound webhook. Never carries a secret.
curl -X PATCH 'https://api.sendly.now/api/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "success": true, "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "url": "http://example.com", "eventTypes": [ "email.sent" ], "status": "ACTIVE", "domains": [ "string" ], "consecutiveFailures": 0, "disabledAt": "2019-08-24T14:15:22Z", "previousSecretExpiresAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}