Automations

Trigger automation via webhook (GET)

get

Triggers an automation using webhook data sent via GET request query parameters. Query parameters are extracted using configured JSONPath extractors.

    Requires authentication via API key headers:
    - X-API-Key: Your API key
    - X-User-ID: Your user ID
    - X-Business-ID: Your business ID

Authorizations

apiKey & businessId & userId

X-API-KEYstringRequired

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

Path parameters

automation_identifierstringRequired

webhook_namestringRequired

The webhook name (must match trigger configuration)

Query parameters

record_emailstringOptional

Record email for contact-based automations (query param or body)

record_idstringOptional

Record UUID for record-based automations (query param or body)

record_namestringOptional

Record name for custom object automations (query param or body)

Responses

200Success

application/json

execution_idstring · uuid · nullableRequired

automation_idstring · uuidRequired

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

get

/api/automations/{automation_identifier}/webhook/{webhook_name}

HTTPcURLJavaScriptPython

GET /api/automations/{automation_identifier}/webhook/{webhook_name} HTTP/1.1
X-API-KEY: YOUR_API_KEY
X-BUSINESS-ID: YOUR_API_KEY
X-USER-ID: YOUR_API_KEY
Accept: */*

{
  "execution_id": "123e4567-e89b-12d3-a456-426614174000",
  "automation_id": "123e4567-e89b-12d3-a456-426614174000"
}

Trigger automation via webhook (POST)

post

Triggers an automation using webhook data sent via POST request. Accepts arbitrary JSON/XML/form data and maps it to automation variables using JSONPath extractors.

    Requires authentication via API key headers:
    - X-API-Key: Your API key
    - X-User-ID: Your user ID
    - X-Business-ID: Your business ID

Authorizations

apiKey & businessId & userId

X-API-KEYstringRequired

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

Path parameters

automation_identifierstringRequired

webhook_namestringRequired

The webhook name (must match trigger configuration)

Query parameters

record_emailstringOptional

Record email for contact-based automations (query param or body)

record_idstringOptional

Record UUID for record-based automations (query param or body)

record_namestringOptional

Record name for custom object automations (query param or body)

Body

application/json

record_idstring · uuidOptional

Record UUID for record-based automations (fallback if not in query)

record_namestring · min: 1Optional

Record name for custom object automations (fallback if not in query)

record_emailstring · email · min: 1Optional

Record email for contact-based automations (fallback if not in query)

Responses

200Success

application/json

execution_idstring · uuid · nullableRequired

automation_idstring · uuidRequired

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

post

/api/automations/{automation_identifier}/webhook/{webhook_name}

HTTPcURLJavaScriptPython

POST /api/automations/{automation_identifier}/webhook/{webhook_name} HTTP/1.1
X-API-KEY: YOUR_API_KEY
X-BUSINESS-ID: YOUR_API_KEY
X-USER-ID: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "user": {
    "name": "John",
    "email": "[email protected]"
  },
  "amount": 100
}

Simple webhook with nested dataWebhook with record_id in body

{
  "execution_id": "123e4567-e89b-12d3-a456-426614174000",
  "automation_id": "123e4567-e89b-12d3-a456-426614174000"
}