Sign in
Executions

Trigger a new execution by POST webhook trigger

Changed on
post/api/v1/{tenant}/executions/webhook/{namespace}/{id}/{key}/{path}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/{tenant}/executions/webhook/{namespace}/{id}/{key}/{path}
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

namespacestring required

The flow namespace

idstring required

The flow id

keystring required

The webhook trigger uid

pathstring nullable required

Optional additional path segments

tenantstring required

Response

On success

tenantIdstring
idstring
namespacestring
flowIdstring
flowRevisioninteger
outputsobject
urlstring uri

Example response

{
  "outputs": {
    "key": "{}"
  },
  "flowRevision": 0,
  "tenantId": "tenantId",
  "namespace": "namespace",
  "id": "id",
  "trigger": {
    "variables": {
      "key": ""
    },
    "logFile": "https://openapi-generator.tech",
    "id": "id",
    "type": "type"
  },
  "state": {
    "duration": "duration",
    "current": "CREATED",
    "endDate": "2000-01-23T04:56:07.000+00:00",
    "histories": [
      {
        "date": "2000-01-23T04:56:07.000+00:00",
        "state": null
      },
      {
        "date": "2000-01-23T04:56:07.000+00:00",
        "state": null
      }
    ],
    "startDate": "2000-01-23T04:56:07.000+00:00"
  },
  "flowId": "flowId",
  "url": "https://openapi-generator.tech",
  "labels": [
    {
      "value": "value",
      "key": "key"
    },
    {
      "value": "value",
      "key": "key"
    }
  ]
}

Changes