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

Schema

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

Responses

202 (application/json)

Accepted - CloudFlow execution started.

{
  "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"
    }
  }
}

400 (application/json)

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)

Not Found - The requested resource does not exist.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

500 (application/json)

Internal Server Error - Something went wrong with the DoiT API server.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: trigger-cloudflow-webhook, triggercloudflowwebhook