mammoth webhook
Generated from mammoth-cli 2.4.2, released 2026-11-02:
mammoth schema list,mammoth capability listand the CLI's own--help. Do not edit by hand; runnpm run docs:capabilities.
Manage webhooks. 7 commands.
Every command also takes the global flags (--output, --yes, --confirm, --dry-run, --input, --profile, ...), which are not repeated below. --input takes a JSON or YAML document of the input fields; mammoth schema get COMMAND_ID prints a command's full input schema.
Confirmation. Commands marked --yes --confirm TARGET or --yes always need those flags, even at a terminal: they never prompt. Commands marked "--yes or prompt" ask at an interactive terminal (table output, no --no-input) and otherwise need --yes. --dry-run skips confirmation and sends nothing.
Summary
| Command | What it does | Effect | Confirmation |
|---|---|---|---|
webhook create | Create a webhook. Name comes from a positional or the 'name' field. | Benign mutation | — |
webhook delete | Delete one webhook by id. Prompt or '--yes' required. | Destructive | --yes or prompt |
webhook get | Get one webhook by id. The webhook id is a required positional. | Read | — |
webhook list | List webhook datasets. 'limit'/'offset' come from '--input'. | Read | — |
webhook send | Send data to a webhook via POST. 'webhook_uri'/'data' are required. | Benign mutation | — |
webhook send-get | Send data to a webhook via GET. 'webhook_uri' is required, 'params' optional. | Benign mutation | — |
webhook update | Update a webhook. The webhook id is positional; other fields optional. | Benign mutation | — |
webhook commands
mammoth webhook create
Create a webhook. Name comes from a positional or the 'name' field.
mammoth webhook create 'Revenue report'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
NAME | positional | no | — | str | Name of the new webhook; or pass it via the 'name' input field. Or the name input field. |
name | --input field | no | Generic Webhook | str | |
mode | --input field | no | replace | str | WebhookMode | |
folder_resource_id | --input field | no | — | str | |
origins | --input field | no | * | str | |
is_secure | --input field | no | false | bool |
- Effect: Benign mutation, scope
profile· Confirmation: none - Preconditions: Secure creation uses the secret-output rule (--secret-out/--show-secret).
- Id:
webhook.create· Result:WebhookCreateResult· Backed by: SDKmammoth.api.webhooks.WebhooksAPI.create, APIPOST /workspaces/{workspace_id}/projects/{project_id}/webhooks(CreateAWebhook)
mammoth webhook delete
Delete one webhook by id. Prompt or '--yes' required.
mammoth webhook delete 123 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
WEBHOOK_ID | positional | yes | — | int | ID of the webhook. |
- Effect: Destructive, scope
profile· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Resolve webhook before confirmation.
- Id:
webhook.delete· Result:WebhookDeleteResult· Backed by: SDKmammoth.api.webhooks.WebhooksAPI.delete, APIDELETE /workspaces/{workspace_id}/projects/{project_id}/webhooks/{webhook_id}(DeleteWebhook)
mammoth webhook get
Get one webhook by id. The webhook id is a required positional.
mammoth webhook get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
WEBHOOK_ID | positional | yes | — | int | ID of the webhook. |
- Effect: Read, scope
profile· Confirmation: none - Preconditions: Redact secret.
- Id:
webhook.get· Result:WebhookGetResult· Backed by: SDKmammoth.api.webhooks.WebhooksAPI.get, APIGET /workspaces/{workspace_id}/projects/{project_id}/webhooks/{webhook_id}(GetWebhookDetails)
mammoth webhook list
List webhook datasets. 'limit'/'offset' come from '--input'.
mammoth webhook list
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
limit | --input field | no | 50 | int | |
offset | --input field | no | 0 | int |
- Effect: Read, scope
profile· Confirmation: none · Pages:offset - Preconditions: Current SDK discards pagination metadata.
- Id:
webhook.list· Result:WebhookListResult· Backed by: SDKmammoth.api.webhooks.WebhooksAPI.list, APIGET /workspaces/{workspace_id}/projects/{project_id}/webhooks(ListWebhooks)
mammoth webhook send
Send data to a webhook via POST. 'webhook_uri'/'data' are required.
mammoth webhook send --input '{"webhook_uri": "https://example.com/data.csv", "data": {"name": "Status"}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
webhook_uri | --input field | yes | — | str | |
data | --input field | yes | — | dict[str, any] |
- Effect: Benign mutation, scope
profile· Confirmation: none - Preconditions: Delivers a payload to the webhook, which ingests it into its dataset. Never retry a send: each call adds data. Check
webhook getfirst. - Id:
webhook.send· Result:WebhookSendResult· Backed by: SDKmammoth.api.webhooks.WebhooksAPI.send_data, APIPOST /webhooks/data/{webhook_uri}(AddDataToWebhook)
mammoth webhook send-get
Send data to a webhook via GET. 'webhook_uri' is required, 'params' optional.
mammoth webhook send-get --input '{"webhook_uri": "https://example.com/data.csv"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
webhook_uri | --input field | yes | — | str | |
params | --input field | no | — | dict[str, any] |
- Effect: Benign mutation, scope
profile· Confirmation: none - Preconditions: webhook send-get is a mutation despite HTTP GET, and it is never retried. Reject an empty query; never log the URI if the server treats it as a capability.
- Id:
webhook.send-get· Result:WebhookSendGetResult· Backed by: SDKmammoth.api.webhooks.WebhooksAPI.send_data_get, APIGET /webhooks/data/{webhook_uri}(AddDataToWebhookUsingGetMethod)
mammoth webhook update
Update a webhook. The webhook id is positional; other fields optional.
mammoth webhook update 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
WEBHOOK_ID | positional | yes | — | int | ID of the webhook. |
mode | --input field | no | — | str | WebhookMode | None | |
origins | --input field | no | — | str | |
is_secure | --input field | no | — | bool |
- Effect: Benign mutation, scope
profile· Confirmation: none - Preconditions: Reject an empty patch; a newly issued secret uses the secret-output rule.
- Id:
webhook.update· Result:WebhookUpdateResult· Backed by: SDKmammoth.api.webhooks.WebhooksAPI.update, APIPATCH /workspaces/{workspace_id}/projects/{project_id}/webhooks/{webhook_id}(UpdateWebhookConfigurations)