v1

latestOpenAPI 3.0.02026-07-1313126.3 KB

webhooks

Trigger automation with webhook

This endpoint triggers an Automation with a Webhook as the trigger.

post/webhook/automation/{automation_id}

Path parameters

automation_idstring required

The unique ID of the automation associated with the webhook. Only Automations using the Webhook trigger are supported.

Request body

object required

The body of the request can be any arbitrary JSON object. There are no required fields, and you can send any data your external system needs to trigger the automation and pass it into downstream actions.

While an Automation is in Draft Mode, this data will be used to update the test values for the automation. In Live Mode, this data will trigger the automation to process the data in real-time.

Response

Successful response

errorobject nullable

An object containing error details, if any. This field will be populated if the API request fails or encounters an error. If the request is successful, this field will be null or omitted.

dataobject required

Contains the response data for the successful request. This field will vary based on the specific API endpoint being called and contains the main data returned from the API. For example, it may include information about a created contact, agent, or webhook subscription.