Overview
Domains
curl --request PATCH \
--url https://app.sendmux.ai/api/v1/webhooks/{public_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"event_types": [
"ses.bounce"
],
"enabled": true
}
'{
"ok": true,
"data": {
"id": "twhk_clxxxxxxxxxxxxxxxxxxxxxxxxx",
"url": "https://hooks.acme.com/sendmux",
"event_types": [
"ses.bounce",
"ses.complaint"
],
"enabled": true,
"failing": false,
"created_at": "2026-04-23T09:12:00Z",
"updated_at": "2026-04-23T09:12:00Z"
},
"meta": {
"request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}Update a webhook subscription
Updates the URL, event types, or enabled flag. Any field omitted from the request body is left unchanged. The signing secret is unaffected — use POST /webhooks/{id}/rotate-secret to rotate it.
curl --request PATCH \
--url https://app.sendmux.ai/api/v1/webhooks/{public_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"event_types": [
"ses.bounce"
],
"enabled": true
}
'{
"ok": true,
"data": {
"id": "twhk_clxxxxxxxxxxxxxxxxxxxxxxxxx",
"url": "https://hooks.acme.com/sendmux",
"event_types": [
"ses.bounce",
"ses.complaint"
],
"enabled": true,
"failing": false,
"created_at": "2026-04-23T09:12:00Z",
"updated_at": "2026-04-23T09:12:00Z"
},
"meta": {
"request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}Authorizations
Sendmux API key. Obtain from the dashboard under API Keys. Format: smx_root_...
Path Parameters
Webhook public ID
Body
New HTTPS endpoint. Must be https://.
Replaces the full event-type list. At least one must be provided.
1Event types a webhook may subscribe to. sendmux.test is accepted so you can verify end-to-end delivery via POST /webhooks/{id}/test.
ses.bounce, ses.complaint, ses.delivery, ses.reject, ses.delivery_delay, mail.inbound, sendmux.test When toggled from false to true, also clears the failing flag — retry deliveries resume on the next matching event.
Response
Updated subscription
true Hide child attributes
Hide child attributes
Webhook public ID
"twhk_clxxxxxxxxxxxxxxxxxxxxxxxxx"
HTTPS endpoint that receives signed event POSTs.
"https://hooks.acme.com/sendmux"
Event types this subscription receives.
Event types a webhook may subscribe to. sendmux.test is accepted so you can verify end-to-end delivery via POST /webhooks/{id}/test.
ses.bounce, ses.complaint, ses.delivery, ses.reject, ses.delivery_delay, mail.inbound, sendmux.test ["ses.bounce", "ses.complaint"]When false, no events are delivered to this subscription.
true
True when the 24-hour retry window has been exhausted for this subscription. Reset by updating the subscription (e.g. fixing the URL) and re-enabling.
false
ISO 8601 creation timestamp
"2026-04-23T09:12:00Z"
ISO 8601 last-modified timestamp
"2026-04-23T09:12:00Z"
Was this page helpful?