Skip to main content

trigger-cloudflow-webhook

dci trigger-cloudflow-webhook flowId

Triggers execution of a published CloudFlow whose first node is a webhook trigger. The request body must be valid JSON and is passed to the flow as webhook payload data.

Request

Content-Type: application/json

Example

{
"key": "value"
}

Schema

{
"type": "object",
"properties": {},
"additionalProperties": true,
"description": "Arbitrary JSON payload delivered to the webhook trigger node."
}

Output

Accepted - CloudFlow execution started.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

FieldTypeDescription
executionLinkstringConsole URL for the started CloudFlow execution history entry.
Raw JSON schema
{
"type": "object",
"required": [
"executionLink"
],
"properties": {
"executionLink": {
"type": "string",
"description": "Console URL for the started CloudFlow execution history entry.",
"example": "https://console.doit.com/customers/customer-id/cloudflow/history/execution-id"
}
}
}

Errors

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP statusExit codeError codeMeaning
40030VALIDATION_ERRORThe arguments or request body were rejected. Review the command's flags and payload.
40110AUTHENTICATION_FAILEDNot signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
40311PERMISSION_DENIEDThe DoiT user or the active customer context does not have access.
40420RESOURCE_NOT_FOUNDThe requested resource does not exist. Check the identifier argument.
40921RESOURCE_CONFLICTThe operation conflicts with the resource's current state.
50040API_SERVER_ERRORThe API failed to process the request. Retryable; contact DoiT support if it persists.

Aliases: triggercloudflowwebhook