Skip to content
Build with Mammoth › CLI reference: open the docs menu

mammoth webhook

Generated from mammoth-cli 2.4.2, released 2026-11-02: mammoth schema list, mammoth capability list and the CLI's own --help. Do not edit by hand; run npm 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

CommandWhat it doesEffectConfirmation
webhook createCreate a webhook. Name comes from a positional or the 'name' field.Benign mutation—
webhook deleteDelete one webhook by id. Prompt or '--yes' required.Destructive--yes or prompt
webhook getGet one webhook by id. The webhook id is a required positional.Read—
webhook listList webhook datasets. 'limit'/'offset' come from '--input'.Read—
webhook sendSend data to a webhook via POST. 'webhook_uri'/'data' are required.Benign mutation—
webhook send-getSend data to a webhook via GET. 'webhook_uri' is required, 'params' optional.Benign mutation—
webhook updateUpdate 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'
NamePassed asRequiredDefaultTypeNotes
NAMEpositionalno—strName of the new webhook; or pass it via the 'name' input field. Or the name input field.
name--input fieldnoGeneric Webhookstr
mode--input fieldnoreplacestr | WebhookMode
folder_resource_id--input fieldno—str
origins--input fieldno*str
is_secure--input fieldnofalsebool
  • 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: SDK mammoth.api.webhooks.WebhooksAPI.create, API POST /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
NamePassed asRequiredDefaultTypeNotes
WEBHOOK_IDpositionalyes—intID 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: SDK mammoth.api.webhooks.WebhooksAPI.delete, API DELETE /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
NamePassed asRequiredDefaultTypeNotes
WEBHOOK_IDpositionalyes—intID of the webhook.
  • Effect: Read, scope profile · Confirmation: none
  • Preconditions: Redact secret.
  • Id: webhook.get · Result: WebhookGetResult · Backed by: SDK mammoth.api.webhooks.WebhooksAPI.get, API GET /workspaces/{workspace_id}/projects/{project_id}/webhooks/{webhook_id} (GetWebhookDetails)

mammoth webhook list

List webhook datasets. 'limit'/'offset' come from '--input'.

mammoth webhook list
NamePassed asRequiredDefaultTypeNotes
limit--input fieldno50int
offset--input fieldno0int
  • Effect: Read, scope profile · Confirmation: none · Pages: offset
  • Preconditions: Current SDK discards pagination metadata.
  • Id: webhook.list · Result: WebhookListResult · Backed by: SDK mammoth.api.webhooks.WebhooksAPI.list, API GET /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"}}'
NamePassed asRequiredDefaultTypeNotes
webhook_uri--input fieldyes—str
data--input fieldyes—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 get first.
  • Id: webhook.send · Result: WebhookSendResult · Backed by: SDK mammoth.api.webhooks.WebhooksAPI.send_data, API POST /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"}'
NamePassed asRequiredDefaultTypeNotes
webhook_uri--input fieldyes—str
params--input fieldno—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: SDK mammoth.api.webhooks.WebhooksAPI.send_data_get, API GET /webhooks/data/{webhook_uri} (AddDataToWebhookUsingGetMethod)

mammoth webhook update

Update a webhook. The webhook id is positional; other fields optional.

mammoth webhook update 123
NamePassed asRequiredDefaultTypeNotes
WEBHOOK_IDpositionalyes—intID of the webhook.
mode--input fieldno—str | WebhookMode | None
origins--input fieldno—str
is_secure--input fieldno—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: SDK mammoth.api.webhooks.WebhooksAPI.update, API PATCH /workspaces/{workspace_id}/projects/{project_id}/webhooks/{webhook_id} (UpdateWebhookConfigurations)

Report an issue · support@mammoth.io