Setting the file. One moment.
Subchapter 4.16
references/webhooks.mdMarkdown5 KBView on GitHub
--limit <n> | number | 10 | Max results (1-100) |
--after <cursor> | string | — | Forward pagination |
--before <cursor> | string | — | Backward pagination |
| Flag | Type | Required | Description |
|---|---|---|---|
--endpoint <url> | string | Yes (non-interactive) | HTTPS webhook URL |
--events <events...> | string[] | Yes (non-interactive) | Event types or all |
All 17 events:
email.sent, email.delivered, email.delivery_delayed, email.bounced, email.complained, email.opened, email.clicked, email.failed, email.scheduled, email.suppressed, email.receivedcontact.created, contact.updated, contact.deleteddomain.created, domain.updated, domain.deletedOutput includes signing_secret — shown once only. Save immediately.
Argument: <id> — Webhook ID
Note: signing_secret is NOT returned by get (only at creation or rotation).
Argument: <id> — Webhook ID
| Flag | Type | Description |
|---|---|---|
--endpoint <url> | string | New HTTPS URL |
--events <events...> | string[] | Replace event list (not additive) |
--status <status> | string | enabled | disabled |
Argument: <id> — Webhook ID
| Flag | Type | Required | Description |
|---|---|---|---|
--yes | boolean | Yes (non-interactive) | Skip confirmation |
Argument: <id> — Webhook ID
Generates a new signing secret. For 24 hours, payloads are signed with both the new and the previous secret, so either one verifies them. After that, only the new secret does.
Returns {"object":"webhook","id":"<uuid>","signing_secret":"whsec_..."} —
shown once only, save immediately.
Lists the events Resend delivered to a webhook, most recent first.
Argument: [webhookId] — Webhook ID
| Flag | Type | Default | Description |
|---|---|---|---|
--limit <n> | number | 10 | Max results (1-100) |
--after <cursor> | string | — | Forward pagination (an event ID) |
No --before. These endpoints paginate forward only.
status values: pending, attempting, success, failed.
Arguments: [webhookId] [eventId]
Returns the event with next_attempt_at and the payload that was sent to your endpoint.
next_attempt_at is null once the event reaches success or failed.
Lists the delivery attempts for one event, most recent first. Each attempt records the
http_status_code and response body your endpoint returned.
Arguments: [webhookId] [eventId]
| Flag | Type | Default | Description |
|---|---|---|---|
--limit <n> | number | 10 | Max results (1-100) |
--after <cursor> | string | — | Forward pagination (an attempt ID) |
Debugging a failed delivery:
resend webhooks events list <webhook-id> — find the eventresend webhooks events get <webhook-id> <event-id> — see what we sentresend webhooks events attempts <webhook-id> <event-id> — see what your endpoint returnedresend webhooks events replay <webhook-id> <event-id> — queue another deliveryQueues one more delivery of the event. Does not schedule automatic retries.
Arguments: [webhookId] [eventId]
The webhook must be enabled — re-enable it first with
resend webhooks update <webhook-id> --status enabled.
Returns {"object":"webhook_event","id":"<event-id>"} — no type, status,
or payload (use events get for those).
Start a local server that receives Resend webhook events in real time via a public tunnel URL.
| Flag | Type | Default | Description |
|---|---|---|---|
--url <url> | string | — | Public tunnel URL for receiving webhooks (required in non-interactive) |
--forward-to <url> | string | — | Forward payloads to this local URL (preserves Svix headers) |
--events <events...> | string[] | all | Event types to listen for |
--port <port> | number | 4318 | Local server port |
Behavior:
--port--url--forward-to with original Svix headers