GET/api/v1/webhooks/templates
Built-in and custom payload templates.
- CLI
sendmock webhook template list- MCP tool
sendmock_webhook_template_list- In the app
- Webhooks > Templates
Answer
200 WebhookTemplateSummary[]
Webhook templates
GET
POST/api/v1/webhooks/templates
Add a custom template, starting as native JSON.
- CLI
sendmock webhook template create- MCP tool
sendmock_webhook_template_create- In the app
- Webhooks > Templates > New template
Request body (application/json)
TemplateCreateRequest : Body of POST /api/v1/webhooks/templates (a new blank custom template).
| Field | Type | Description |
|---|---|---|
| name | string | The name of the new blank custom template.Example: Order webhook |
Answer
201 WebhookTemplateSummary
Errors: 400, as { error: { code, message } }
Try it in Demo mode
GET/api/v1/webhooks/templates/{templateId}
One template with its method, headers and body template.
- CLI
sendmock webhook template show <templateId>- MCP tool
sendmock_webhook_template_get- In the app
- Webhooks > Templates > open a template
Answer
200 WebhookTemplateDetail
Errors: 404, as { error: { code, message } }
Try it in Demo mode
PATCH/api/v1/webhooks/templates/{templateId}
Edit a template; each save keeps a revision, 422 when it does not render.
- CLI
sendmock webhook template update <templateId>- MCP tool
sendmock_webhook_template_update- In the app
- Webhooks > Templates > template > Edit, Save template
Request body (application/json)
TemplateUpdate : Body of PATCH /api/v1/webhooks/templates/{templateId}; metadata is ignored for built-ins.
| Field | Type | Description |
|---|---|---|
| name? | string | The template's name.Example: Order webhook |
| description? | string | What the template sends and where.Example: Posts each received email to the orders app. |
| events? | AppEventType[] | The event types the template is made for.One of: email.received, email.inbound, email.opened, email.clicked, email.delivered, email.deferred, email.bounced, email.complained, email.unsubscribed, email.released, email.deleted, sms.sent, sms.status, sms.opened, sms.inbound, sms.reply_webhook, verify.started, verify.checked, verify.expired, push.sent, push.failed, http.captured, payment.created, payment.authorized, payment.succeeded, payment.failed, payment.canceled, payment.refunded, payment.partially_refunded, payment.dispute_opened, payment.dispute_updated, payment.dispute_closed, checkout.completed, checkout.expired, subscription.created, subscription.renewed, subscription.payment_failed, subscription.canceled, webhook.delivered, webhook.failed, test.ping, traffic.pruned |
| required_variables? | string[] | Variables an endpoint must define to use it. |
| method | HttpMethod | The HTTP method.One of: GET, POST, PUT, PATCH, DELETEExample: POST |
| content_type | string | The body's content type.Example: application/json |
| header_templates | object | Header name to a template, e.g. "X-Twilio-Signature": "{{ twilio_signature(...) }}". |
| body_template | string | The body, a template over the event, its data and the variables.Example: {"subject": "{{ data.subject }}"} |
Answer
200 WebhookTemplateDetail
Errors: 400, 404, 409, 422, as { error: { code, message } }
Try it in Demo mode
DELETE/api/v1/webhooks/templates/{templateId}
Delete a custom template; 409 while endpoints use it.
- CLI
sendmock webhook template delete <templateId>- MCP tool
sendmock_webhook_template_delete- In the app
- Webhooks > Templates > template > Delete
Answer
204 No content
Errors: 404, 409, as { error: { code, message } }
Try it in Demo mode
POST/api/v1/webhooks/templates/import
Import a template file; 409 when the id is taken.
- CLI
sendmock webhook template import <file>- MCP tool
sendmock_webhook_template_import- In the app
- Webhooks > Templates > Import a template
Request body (application/json)
TemplateImportRequest : Body of POST /api/v1/webhooks/templates/import.
| Field | Type | Description |
|---|---|---|
| file_text | string | The template file's text, TOML or JSON as exported.Example: id = "custom.order_webhook"
name = "Order webhook" |
| on_conflict? | "replace" | "copy" | What to do when the id is taken; left out, the API answers 409.One of: replace, copyExample: copy |
Answer
201 WebhookTemplateSummary
Errors: 409, 422, as { error: { code, message } }
Try it in Demo mode
GET/api/v1/webhooks/templates/{templateId}/export
The template as TOML (variable names, never values).
- CLI
sendmock webhook template export <templateId>- MCP tool
sendmock_webhook_template_export- In the app
- Webhooks > Templates > template > Export
Answer
200 string (application/toml)
Errors: 404, as { error: { code, message } }
Try it in Demo mode
GET/api/v1/webhooks/templates/{templateId}/revisions
Saved revisions, newest first.
- CLI
sendmock webhook template history <templateId>- MCP tool
sendmock_webhook_template_revisions- In the app
- Webhooks > Templates > template > History
Answer
200 TemplateRevision[]
Errors: 404, as { error: { code, message } }
Try it in Demo mode
POST/api/v1/webhooks/templates/{templateId}/revisions/{revision}/restore
Restore a revision as a new save.
- CLI
sendmock webhook template restore <templateId> <revision>- MCP tool
sendmock_webhook_template_restore- In the app
- Webhooks > Templates > template > History > Restore
Answer
200 WebhookTemplateDetail
Errors: 404, as { error: { code, message } }
Try it in Demo mode
POST/api/v1/webhooks/templates/{templateId}/render
Render against an email, an SMS or the sample, optionally a draft.
- CLI
sendmock webhook template render <templateId>- MCP tool
sendmock_webhook_template_render- In the app
- Webhooks > Templates > template > Preview
Request body (application/json)
TemplateRenderRequest : Body of POST /api/v1/webhooks/templates/{templateId}/render; empty for the sample.
| Field | Type | Description |
|---|---|---|
| email_id? | Ulid | Render against this email; with no IDs the sample event is used.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D |
| sms_id? | Ulid | Render against this SMS.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D |
| http_request_id? | Ulid | A captured HTTP request, as the data of an http.captured event.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D |
| payment_id? | Ulid | A payment, as the data of the event its latest state stands for.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D |
| draft? | TemplateDraft | Unsaved edits to preview instead of the stored template. |
Answer
200 TemplateRenderResult
Errors: 404, as { error: { code, message } }
Try it in Demo mode
POST/api/v1/webhooks/templates/{templateId}/reset
Put an edited built-in template back as shipped.
- CLI
sendmock webhook template reset <templateId>- MCP tool
sendmock_webhook_template_reset- In the app
- Webhooks > Templates > template > Reset to default
Answer
200 WebhookTemplateDetail
Errors: 404, 409, as { error: { code, message } }
Try it in Demo mode
POST/api/v1/webhooks/templates/{templateId}/clone
Copy a template into a new custom one.
- CLI
sendmock webhook template clone <templateId>- MCP tool
sendmock_webhook_template_clone- In the app
- Webhooks > Templates > template > Clone
Request body (application/json)
TemplateCloneRequest : Body of POST /api/v1/webhooks/templates/{templateId}/clone.
| Field | Type | Description |
|---|---|---|
| name | string | The name of the copy.Example: Slack alerts (team) |
Answer
201 WebhookTemplateSummary
Errors: 400, 404, as { error: { code, message } }
Try it in Demo mode
GET/api/v1/webhooks/template-reference
Every value a template can read for the chosen events.
- CLI
sendmock webhook template reference- MCP tool
sendmock_webhook_template_reference- In the app
- Webhooks > Templates > template editor > reference panel
Answer
200 TemplateReference