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"}}'
{
  "received": true,
  "event_id": "evt_01HF2MNW2ZQ1Z8E2S3J",
  "delivery": {
    "bound_to_call": true,
    "sent_to_llm": false
  }
}

Authorizations

​
X-Api-Key
string
header
required

API key generated for External Events Webhook (e.g., via poly api_key ... --name "EXTERNAL_EVENTS_WEBHOOK" --actions "POST:/api/v1/webhook").

Query Parameters

​
event_id_location
enum<string>
required

Where the event id is located in the incoming request.

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

Name or dotted path to the event id within the chosen location (e.g. cid or path.to.object.property).

​
account_id
string
required

PolyAI account id.

​
project_id
string
required

PolyAI project id.

Body

Response

Accepted and delivered to the conversation runtime.

​
received
boolean
​
event_id
string
​
delivery
object
⌘I