Trigger automation from any source - Flow

POST

/

ai

/

trigger

Trigger automation from any source

curl --request POST \
  --url https://backend.branch.flowengineering.com/ai/trigger \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'customer: <customer>' \
  --data '
{
  "context": {},
  "source": "<string>",
  "project_id": "<string>",
  "wait": false
}
'

import requests

url = "https://backend.branch.flowengineering.com/ai/trigger"

payload = {
    "context": {},
    "source": "<string>",
    "project_id": "<string>",
    "wait": False
}
headers = {
    "customer": "<customer>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    customer: '<customer>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({context: {}, source: '<string>', project_id: '<string>', wait: false})
};

fetch('https://backend.branch.flowengineering.com/ai/trigger', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "results": [
    {
      "agent_id": "<string>",
      "automation_id": "<string>",
      "automation_name": "<string>",
      "branches": [],
      "error": "<string>",
      "integration_grade": "<string>",
      "integration_response": "<string>",
      "project_id": "<string>",
      "project_slug": "<string>",
      "status": "running"
    }
  ]
}

{
  "results": [
    {
      "agent_id": "<string>",
      "automation_id": "<string>",
      "automation_name": "<string>",
      "branches": [],
      "error": "<string>",
      "integration_grade": "<string>",
      "integration_response": "<string>",
      "project_id": "<string>",
      "project_slug": "<string>",
      "status": "running"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Headers

customer

string

required

Workspace identifier

Body

application/json

context

object

required

source

string

required

The automation trigger source to fire. One of the built-in sources (branch, endpoint, import, schedule, slack, github, gitlab, onshape), or the name given to an automation's custom webhook trigger.

project_id

string

wait

boolean

default:false

Whether to hold the request open until every matched automation has finished running. Defaults to false: the runs start, the response is 202 with one run id each, and you read results from GET /ai/trigger/runs. Pass true only when the caller genuinely cannot poll — it makes response time the sum of the runs, an agent run has no time bound, and the request dies on the shortest timeout between you and this API (our load balancer cuts an idle connection at 60s), which loses the response while the runs themselves carry on.

Response

results

object[]

required

Show child attributes

Trigger automation from any source

curl --request POST \
  --url https://backend.branch.flowengineering.com/ai/trigger \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'customer: <customer>' \
  --data '
{
  "context": {},
  "source": "<string>",
  "project_id": "<string>",
  "wait": false
}
'

import requests

url = "https://backend.branch.flowengineering.com/ai/trigger"

payload = {
    "context": {},
    "source": "<string>",
    "project_id": "<string>",
    "wait": False
}
headers = {
    "customer": "<customer>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    customer: '<customer>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({context: {}, source: '<string>', project_id: '<string>', wait: false})
};

fetch('https://backend.branch.flowengineering.com/ai/trigger', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "results": [
    {
      "agent_id": "<string>",
      "automation_id": "<string>",
      "automation_name": "<string>",
      "branches": [],
      "error": "<string>",
      "integration_grade": "<string>",
      "integration_response": "<string>",
      "project_id": "<string>",
      "project_slug": "<string>",
      "status": "running"
    }
  ]
}

{
  "results": [
    {
      "agent_id": "<string>",
      "automation_id": "<string>",
      "automation_name": "<string>",
      "branches": [],
      "error": "<string>",
      "integration_grade": "<string>",
      "integration_response": "<string>",
      "project_id": "<string>",
      "project_slug": "<string>",
      "status": "running"
    }
  ]
}