Get started

Quickstart Dashboard tour SDKs and OpenAPI AI tools Recipes Migrating to ZapSMTP

Sending

Sending email Domains & DNS setup Templates and variables Email template editor SMTP relay

Events & data

Webhook events Click actions Tracking and analytics Receiving email

Operations

Deliverability guide Testing & simulator Errors, limits & paging Teams & client accounts

API reference

Emails Domains Webhooks

List webhooks Create a webhook Retrieve a webhook Update a webhook Send a test event List delivery attempts List events Retrieve an event Replay an event Rotate the signing secret Delete a webhook

Click actions Templates Variables Modules, images & timers Received emails Inbound setup Suppressions Statistics Keys & SMTP credentials Logs & usage Simulator & IPs

OpenAPI 3.1 spec llms.txt

Test API keyRuns examples for real against your account. Test keys only; kept in this tab, never stored on our side. Get a key

ZapSMTP / Docs / API reference

Webhooks

Register an HTTPS endpoint and choose events. Every request is signed; see Webhook events for payloads and signature verification. filter.actions narrows email.clicked to some click actions.

GETList webhooks/v1/webhooksList webhook endpoints (newest first); secrets are omitted..POSTCreate a webhook/v1/webhooksCreate a webhook endpoint; the signing secret is returned..GETRetrieve a webhook/v1/webhooks/{id}Retrieve a webhook endpoint including its signing secret..PATCHUpdate a webhook/v1/webhooks/{id}Update a webhook's URL, events, click-action filter or enabled state..POSTSend a test event/v1/webhooks/{id}/testSend a signed sample event to the endpoint now and report the result..GETList delivery attempts/v1/webhooks/{id}/deliveriesList the last 100 delivery attempts of a webhook (newest first)..GETList events/v1/webhooks/{id}/eventsEvents sent to this endpoint, newest first, each with its outcome and number of attempts (from the endpoint’s last 100 delivery attempts)..GETRetrieve an event/v1/webhooks/{id}/events/{event}One event with its payload and every delivery attempt, oldest first..POSTReplay an event/v1/webhooks/{id}/deliveries/{event}/replayRe-send a past event (from the last 100 deliveries) to the endpoint now..POSTRotate the signing secret/v1/webhooks/{id}/rotate-secretGenerate a new signing secret; the old one stays valid for 24 hours..DELETEDelete a webhook/v1/webhooks/{id}Delete a webhook endpoint..