Skip to main content
POST
/
v1
/
external-events
/
webhook
curl -X POST "https://api.us-1.platform.polyai.app/v1/external-events/webhook?event_id_location=payload&event_id_path=cid&account_id=PLATFORM&project_id=PROJECT-123" -H "Content-Type: application/json" -H "X-Api-Key: <YOUR_API_KEY>" -d '{"cid":"evt_01HF2MNW2ZQ1Z8E2S3J","answers":{"name":"Jane Doe","amount":1999,"currency":"GBP"}}'

Authorizations

​
X-Api-Key
string
header
required

API key for the External Events webhook. Contact your PolyAI representative to obtain credentials.

Query Parameters

​
event_id_location
enum<string>
required

Where the external event ID is located in the incoming request.

Available options:
headers,
querystring,
payload
​
event_id_path
string
required

Name or dotted path to the external event ID within the chosen location (for example cid or path.to.object.property).

​
account_id
string
required

PolyAI account ID.

​
project_id
string
required

PolyAI project ID.

Body

The body is of type object.

Response

Accepted – the external event has been received and queued for processing.