Sign in
Business Agent

Send a business event

Tell the agent something happened in your systems (order shipped, document verified) so it messages the consumer about it. The consumer must already have a conversation with the number. Answers 202 with the event id; poll it for the outcome.

post/v1/accounts/{accountId}/business-agent/events

Path parameters

accountIdstring required

WhatsApp social account id (the number must be managed through the Cloud API).

Request body

tostring required

Consumer E.164 phone number.

typestring required
descriptionstring required
payloadstring required

JSON string passed to the agent verbatim.

Example request

{
  "to": "+34600000000",
  "type": "order_shipped"
}

Response

Event accepted

statusstring required
agent_event_idstring

Example response

{
  "status": "accepted"
}

Changes