Skip to main content
POST
Send an Agent Event

Authorizations

x-api-key
string
header
required

Your application's unique ID.

x-api-secret
string
header
required

Your application's secret key.

Body

application/json
phoneId
string
required

The Meta phone number ID of your WhatsApp number (phoneId from List WABA Accounts).

Example:

"123456789012345"

to
string
required

Customer phone number with country code.

Example:

"919876543210"

type
string
required

Short event name, e.g. order_shipped.

Maximum string length: 256
Example:

"order_shipped"

description
string
required

What happened, in plain words, for the agent to act on.

Maximum string length: 1024
Example:

"Order #1042 has shipped with BlueDart, AWB 1234567890."

payload

Optional facts as a JSON object (or JSON string), at most 4096 characters.

Example:
contactId
string

Optional AdsEra contact _id to link the event to.

Response

The event was accepted. Use its _id to check its status.

success
boolean
Example:

true

data
object