GET/api/v1/webhooks/variables
Global and endpoint variables; secret values are masked.
- CLI
sendmock webhook var list- MCP tool
sendmock_webhook_variable_list- In the app
- Webhooks > Variables
Answer
200 WebhookVariable[]
Webhook variables
GET
POST/api/v1/webhooks/variables
Add a variable.
- CLI
sendmock webhook var set <name> <value>- MCP tool
sendmock_webhook_variable_set- In the app
- Webhooks > Variables > Add variable
Request body (application/json)
WebhookVariableInput : Body of POST and PATCH /api/v1/webhooks/variables.
| Field | Type | Description |
|---|---|---|
| name | string | The name templates read it by, as {{ vars.<name> }}.Example: tenant_id |
| kind | VariableKind | text, number, boolean, json and secret are fixed values; dynamic is read from the event, random is generated, computed combines other variables and prompt is asked for on manual sends.One of: text, number, boolean, json, secret, dynamic, random, computed, promptExample: text |
| scope | "global" | "endpoint" | global for every endpoint, or endpoint for one; endpoint values win.One of: global, endpointExample: global |
| endpoint_id | Ulid | null | The endpoint of an endpoint variable; null for global ones.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D |
| value | string | Static value, expression, generator or default; secrets are masked.Example: acme |
| random_mode | "per_send" | "fixed" | null | For random: per_send generates a new value each time, fixed keeps one value until Regenerate; null for other kinds.One of: per_send, fixedExample: per_send |
| description | string | What the variable is for.Example: Tenant every webhook is sent for |
Answer
201 WebhookVariable
Errors: 400, as { error: { code, message } }
Try it in Demo mode
PATCH/api/v1/webhooks/variables/{variableId}
Change a variable.
- CLI
sendmock webhook var update <variableId>- MCP tool
sendmock_webhook_variable_update- In the app
- Webhooks > Variables > Edit
Request body (application/json)
WebhookVariableInput : Body of POST and PATCH /api/v1/webhooks/variables.
| Field | Type | Description |
|---|---|---|
| name | string | The name templates read it by, as {{ vars.<name> }}.Example: tenant_id |
| kind | VariableKind | text, number, boolean, json and secret are fixed values; dynamic is read from the event, random is generated, computed combines other variables and prompt is asked for on manual sends.One of: text, number, boolean, json, secret, dynamic, random, computed, promptExample: text |
| scope | "global" | "endpoint" | global for every endpoint, or endpoint for one; endpoint values win.One of: global, endpointExample: global |
| endpoint_id | Ulid | null | The endpoint of an endpoint variable; null for global ones.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D |
| value | string | Static value, expression, generator or default; secrets are masked.Example: acme |
| random_mode | "per_send" | "fixed" | null | For random: per_send generates a new value each time, fixed keeps one value until Regenerate; null for other kinds.One of: per_send, fixedExample: per_send |
| description | string | What the variable is for.Example: Tenant every webhook is sent for |
Answer
200 WebhookVariable
Errors: 400, 404, as { error: { code, message } }
Try it in Demo mode
DELETE/api/v1/webhooks/variables/{variableId}
Delete a variable.
- CLI
sendmock webhook var unset <variableId>- MCP tool
sendmock_webhook_variable_unset- In the app
- Webhooks > Variables > Delete
Answer
204 No content
Errors: 404, as { error: { code, message } }
Try it in Demo mode
POST/api/v1/webhooks/variables/{variableId}/regenerate
Make a new fixed value for a generated-once random variable.
- CLI
sendmock webhook var regenerate <variableId>- MCP tool
sendmock_webhook_variable_regenerate- In the app
- Webhooks > Variables > Regenerate
Answer
200 WebhookVariable
Errors: 404, 409, as { error: { code, message } }
Try it in Demo mode
POST/api/v1/webhooks/variables/preview
What a variable definition resolves to against the sample.
- CLI
sendmock webhook var preview- MCP tool
sendmock_webhook_variable_preview- In the app
- Webhooks > Variables > variable sheet > Resolves to
Request body (application/json)
VariablePreviewRequest : Body of POST /api/v1/webhooks/variables/preview.
| Field | Type | Description |
|---|---|---|
| kind | VariableKind | The variable kind, as in a variable.One of: text, number, boolean, json, secret, dynamic, random, computed, promptExample: random |
| value | string | The value, expression or generator to try.Example: random_string(16) |
Answer
200 VariablePreviewResult