Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

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 one of:
    - API key headers: X-API-Key, X-User-ID and X-Business-ID
    - OAuth2 bearer token: Authorization: Bearer <token>
    - An active session
Authorizations
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
get/api/automations/{automation_identifier}/webhook/{webhook_name}
GET /api/automations/{automation_identifier}/webhook/{webhook_name} HTTP/1.1
X-API-KEY: YOUR_API_KEY
X-BUSINESS-ID: YOUR_BUSINESS_ID
X-USER-ID: YOUR_USER_ID
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 one of:
    - API key headers: X-API-Key, X-User-ID and X-Business-ID
    - OAuth2 bearer token: Authorization: Bearer <token>
    - An active session
Authorizations
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
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)

dataanyRequired

Arbitrary webhook payload data

Responses
200Success
application/json
execution_idstring · uuid · nullableRequired
automation_idstring · uuidRequired
post/api/automations/{automation_identifier}/webhook/{webhook_name}
POST /api/automations/{automation_identifier}/webhook/{webhook_name} HTTP/1.1
X-API-KEY: YOUR_API_KEY
X-BUSINESS-ID: YOUR_BUSINESS_ID
X-USER-ID: YOUR_USER_ID
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "user": {
    "name": "John",
    "email": "john@example.com"
  },
  "amount": 100
}
{
  "execution_id": "123e4567-e89b-12d3-a456-426614174000",
  "automation_id": "123e4567-e89b-12d3-a456-426614174000"
}
PreviousAutomation2
NextBulk Action Progress

Last updated

Was this helpful?