v1
latestOpenAPI 3.1.02026-07-2687120159.0 KBExternal Events
External events webhook (provider → PolyAI)
External providers POST results back to the Agent runtime. PolyAI extracts the external event ID according to the query parameters, binds the data to the active conversation, and (optionally) feeds it to the LLM.
post/v1/external-events/webhook
Query parameters
event_id_location'headers' | 'querystring' | 'payload' required
Where the external event ID is located in the incoming request.
event_id_pathstring required
Name or dotted path to the external event ID within the chosen location (for example cid or path.to.object.property).
account_idstring required
PolyAI account ID.
project_idstring required
PolyAI project ID.
Request body
object required
Response
Accepted – the external event has been received and queued for processing.