Create a webhook
Register a new outbound webhook. The plaintext signing secret is returned exactly once — store it securely.
Requires the webhooks:write scope — Create, edit, and delete your webhook endpoints.
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.
application/json- body
Body for POST /api/webhooks — register a user webhook for one or more events.
url*stringurieventTypes*array<>1 <= itemsWebhook created
application/json- response
Result of POST /api/webhooks. secret is the only time the plaintext is returned — store it securely.
success*truetruedata*curl -X POST 'https://api.sendly.now/api/webhooks' \ -H 'Content-Type: application/json' \ -d '{ "url": "http://example.com", "eventTypes": [ "email.sent" ]}'{ "success": true, "data": { "webhook": { "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" }, "secret": "string" }}