/api/v1/webhooks/endpointsWhere webhooks go: URL, template, secret and retry policy.
sendmock webhook endpoint listsendmock_webhook_endpoint_list200 WebhookEndpoint[]
/api/v1/webhooks/endpointsAdd an endpoint; its signing secret is generated.
sendmock webhook endpoint createsendmock_webhook_endpoint_createWebhookEndpointInput : Body of POST and PATCH /api/v1/webhooks/endpoints.
| Field | Type | Description |
|---|---|---|
| name | string | A name for the endpoint, shown in lists and deliveries.Example: Orders app |
| url | string | Where deliveries are sent; can use templates.Example: http://localhost:3000/webhooks/sendmock |
| method | HttpMethod | The HTTP method of each delivery.One of: GET, POST, PUT, PATCH, DELETEExample: POST |
| headers | object | Extra headers layered on top of the template's. |
| extra_fields | object | Extra body fields layered on top of the template's. |
| template_id | string | The payload template, e.g. native (Standard Webhooks JSON) or slack.incoming_webhook.Example: native |
| template_mode | TemplateMode | linked follows template updates, detached keeps its own copy.One of: linked, detachedExample: linked |
| timeout_ms | number | How long to wait for your app's answer, in milliseconds.Example: 10000 |
| retry_policy | RetryPolicy | When and how often failed deliveries are retried. |
| is_enabled | boolean | Off endpoints receive no deliveries.Example: true |
| query_params | NameValueTemplate[] | Query parameters added to the URL. |
| body_mode | EndpointBodyMode | How the body is built: template (the payload template), fields (name and value rows), raw (one text template) or none.One of: template, fields, raw, noneExample: template |
| body_fields | EndpointBodyField[] | The rows of fields mode. |
| fields_encoding | "json" | "form" | "multipart" | How fields mode is sent: json, form (x-www-form-urlencoded) or multipart (multipart/form-data, where file fields are fetched from their URL when sent).One of: json, form, multipartExample: json |
| raw_content_type | string | The content type of raw mode.Example: application/json |
| raw_body | string | The body template of raw mode.Example: {"text": "New email: {{ data.subject }}"} |
| render_mode | RenderMode | strict stops a delivery on an undefined variable, lenient renders it empty with a warning.One of: strict, lenientExample: strict |
201 WebhookEndpoint
Errors: 400, as { error: { code, message } }
/api/v1/webhooks/endpoints/{endpointId}One endpoint; its secret masked.
sendmock webhook endpoint show <endpointId>sendmock_webhook_endpoint_get200 WebhookEndpoint
Errors: 404, as { error: { code, message } }
/api/v1/webhooks/endpoints/{endpointId}Change an endpoint; send only the changed keys.
sendmock webhook endpoint update <endpointId>sendmock_webhook_endpoint_updateWebhookEndpointInputPatch
| Field | Type | Description |
|---|---|---|
| name? | string | A name for the endpoint, shown in lists and deliveries.Example: Orders app |
| url? | string | Where deliveries are sent; can use templates.Example: http://localhost:3000/webhooks/sendmock |
| method? | HttpMethod | The HTTP method of each delivery.One of: GET, POST, PUT, PATCH, DELETEExample: POST |
| headers? | object | Extra headers layered on top of the template's. |
| extra_fields? | object | Extra body fields layered on top of the template's. |
| template_id? | string | The payload template, e.g. native (Standard Webhooks JSON) or slack.incoming_webhook.Example: native |
| template_mode? | TemplateMode | linked follows template updates, detached keeps its own copy.One of: linked, detachedExample: linked |
| timeout_ms? | number | How long to wait for your app's answer, in milliseconds.Example: 10000 |
| retry_policy? | RetryPolicy | When and how often failed deliveries are retried. |
| is_enabled? | boolean | Off endpoints receive no deliveries.Example: true |
| query_params? | NameValueTemplate[] | Query parameters added to the URL. |
| body_mode? | EndpointBodyMode | How the body is built: template (the payload template), fields (name and value rows), raw (one text template) or none.One of: template, fields, raw, noneExample: template |
| body_fields? | EndpointBodyField[] | The rows of fields mode. |
| fields_encoding? | "json" | "form" | "multipart" | How fields mode is sent: json, form (x-www-form-urlencoded) or multipart (multipart/form-data, where file fields are fetched from their URL when sent).One of: json, form, multipartExample: json |
| raw_content_type? | string | The content type of raw mode.Example: application/json |
| raw_body? | string | The body template of raw mode.Example: {"text": "New email: {{ data.subject }}"} |
| render_mode? | RenderMode | strict stops a delivery on an undefined variable, lenient renders it empty with a warning.One of: strict, lenientExample: strict |
200 WebhookEndpoint
Errors: 400, 404, as { error: { code, message } }
/api/v1/webhooks/endpoints/{endpointId}Delete an endpoint and its rules.
sendmock webhook endpoint delete <endpointId>sendmock_webhook_endpoint_delete204 No content
Errors: 404, as { error: { code, message } }
/api/v1/webhooks/endpoints/previewRender an unsaved endpoint's request against a message.
sendmock webhook render --endpoint-id <endpointId>sendmock_webhook_renderEndpointPreviewRequest : Body of POST /api/v1/webhooks/endpoints/preview.
| Field | Type | Description |
|---|---|---|
| endpoint? | WebhookEndpointInput | The endpoint settings to render, saved or not; left out, the saved endpoint endpoint_id names is rendered as stored. |
| endpoint_id? | Ulid | A saved endpoint's own variables are used too; alone, its stored settings are rendered.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D |
| email_id? | Ulid | Render against this email; without an email, SMS or request ID the sample event is used.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D |
| sms_id? | Ulid | Render against this SMS.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D |
| http_request_id? | Ulid | Render against this captured HTTP request.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D |
| variables? | object | Send-time values by variable name (no vars.); they win for this render. |
200 EndpointPreviewResult
Errors: 404, as { error: { code, message } }
/api/v1/webhooks/endpoints/{endpointId}/secretReveal the signing secret (asked for after a confirmation).
sendmock webhook endpoint secret <endpointId> --reveal200 RevealedEndpointSecret
Errors: 404, as { error: { code, message } }
/api/v1/webhooks/endpoints/{endpointId}/rotate-secretNew signing secret; the old one keeps working for the overlap.
sendmock webhook endpoint rotate-secret <endpointId>sendmock_webhook_endpoint_rotate_secretRotateSecretRequest : Body of POST /api/v1/webhooks/endpoints/{endpointId}/rotate-secret.
| Field | Type | Description |
|---|---|---|
| overlap_hours | number | How many hours the old secret keeps signing next to the new one (default 24).Example: 24 |
200 WebhookEndpoint
Errors: 400, 404, as { error: { code, message } }
/api/v1/webhooks/endpoints/{endpointId}/save-as-templateSave the endpoint's request as a custom template.
sendmock webhook endpoint save-as-template <endpointId>sendmock_webhook_endpoint_save_as_templateSaveAsTemplateRequest : Body of POST /api/v1/webhooks/saved/{savedId}/template.
| Field | Type | Description |
|---|---|---|
| name | string | The name of the new custom template.Example: Order webhook |
201 WebhookTemplateSummary
Errors: 400, 404, as { error: { code, message } }
/api/v1/webhooks/endpoints/{endpointId}/sendSend a webhook for a chosen message or the sample, by hand.
sendmock webhook send --endpoint <endpointId>sendmock_webhook_sendManualSendRequest : Body of POST /api/v1/webhooks/endpoints/{endpointId}/send; neither id means the sample.
| Field | Type | Description |
|---|---|---|
| email_id? | Ulid | Send this email as the event.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D |
| sms_id? | Ulid | Send this SMS as the event.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D |
| http_request_id? | Ulid | A captured HTTP request, sent as an http.captured event.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D |
| template_id? | string | A template used for this send instead of the endpoint's request.Example: slack.incoming_webhook |
| request? | WebhookEndpointInput | A hand-written request replacing the endpoint's, from the composer. |
| variables? | object | Send-time values by variable name (no vars.), for this send only. |
| body? | string | An edited body, sent as written.Example: {"text": "hello"} |
201 WebhookDelivery
Errors: 404, as { error: { code, message } }
/api/v1/webhooks/endpoints/{endpointId}/testSend a test.ping delivery.
sendmock webhook endpoint test <endpointId>sendmock_webhook_endpoint_test200 WebhookDelivery
Errors: 404, as { error: { code, message } }