Webhooks
ayx one webhook-flow-tasks manages webhook-triggered flow tasks. A webhook flow task links an inbound HTTP call to a flow execution — when the webhook endpoint receives a request, Alteryx One triggers the associated flow. This lets external systems kick off flows without a schedule.
Mutating commands are dry-run by default. Add --apply to commit.
Quick reference
Section titled “Quick reference”| Command | What it does |
|---|---|
ayx one webhook-flow-tasks create --body <json> |
Create a webhook flow task |
ayx one webhook-flow-tasks detail <id> |
Get details for a webhook flow task |
ayx one webhook-flow-tasks delete <id> |
Delete a webhook flow task |
ayx one webhook-flow-tasks test --body <json> |
Send a test trigger to a webhook flow task |
Creating a webhook flow task
Section titled “Creating a webhook flow task”Pass the task definition as a JSON body. The body specifies the flow to trigger and any task configuration.
# Dry-run — shows the request, sends nothingayx one webhook-flow-tasks create --body '{"flow_id": "<id>", ...}'
# Commitayx one webhook-flow-tasks create --body '{"flow_id": "<id>", ...}' --applyAdd --profile <name> to target a non-default workspace.
Getting task details
Section titled “Getting task details”ayx one webhook-flow-tasks detail <id>Use this to retrieve the webhook URL and current task configuration.
Testing a webhook
Section titled “Testing a webhook”Send a test payload to verify the webhook is wired up correctly before production use:
ayx one webhook-flow-tasks test --body '{"test_payload": {}}'test is a mutating command. It sends a real trigger to the platform — include --apply to actually fire it:
ayx one webhook-flow-tasks test --body '{"test_payload": {}}' --applyDeleting a webhook flow task
Section titled “Deleting a webhook flow task”# Dry-runayx one webhook-flow-tasks delete <id>
# Commitayx one webhook-flow-tasks delete <id> --apply --yesJSON output
Section titled “JSON output”ayx --output json one webhook-flow-tasks detail <id>The envelope is { ok, message, timestamp_utc, data } on success; failures also include error_code.
Related
Section titled “Related”- Alteryx One overview — all
ayx oneareas - Safety model — dry-run and
--apply