CloudFlow

Trigger a webhook flow

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.

post/cloudflow/v1/trigger/{flowId}

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/cloudflow/v1/trigger/{flowId}
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Path parameters

flowIdstring required

The unique ID of the published CloudFlow to trigger.

Request body

object required

Arbitrary JSON payload delivered to the webhook trigger node.

Response

Accepted - CloudFlow execution started.

executionLinkstring required

Console URL for the started CloudFlow execution history entry.

Example response

{
  "executionLink": "https://console.doit.com/customers/customer-id/cloudflow/history/execution-id"
}

Changes

No recorded changes to this operation across all 1 revision of this API.