Account Groups4

Account Settings9

Accounts16

Ad Accounts47

Ad Audiences7

Ad Campaigns50

Ad Creatives17

Ad Insights11

Ad Library1

Ad Targeting5

Analytics25

API Keys4

Blogs10

Broadcasts10

Business Agent55

Calls3

Comment Automations6

Comments15

Connect57

Connected Apps2

Contacts7

Conversions14

Custom Fields6

Discord24

GMB Attributes3

GMB Food Menus2

GMB Location Details2

GMB Media3

GMB Place Actions4

GMB Reviews5

GMB Services2

GMB Verifications4

iMessage17

Inbox Analytics7

Instagram5

Invites1

Lead Gen8

LinkedIn Mentions1

Logs1

Media1

Mentions2

Messages16

Messaging Ads3

Phone Numbers30

Posts10

Product Catalogs19

Products3

Profiles5

Queue6

Reach and Frequency4

Reddit Search2

Reviews3

Sequences10

Slack1

SMS22

Tools1

Tracking Tags10

Twitter Engagement8

Usage6

Users2

Validate4

Verify3

Voice18

Webhooks7

WhatsApp46

WhatsApp Calling16

WhatsApp Flows15

WhatsApp Phone Numbers16

WhatsApp Sandbox3

WhatsApp Templates1

Workflows14

Webhooks

Webhook Events55

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

Changed in 4 of the 55 revisions of this API.22

Sep 25, 20262c04683ce69412See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 16, 20263e6ddf2a99ea3See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Sep 15, 20260dba7d004d756See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Sep 9, 202641eff0cffb2d1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history