Operate — Events
Test & Eval

Post agent event

Tells the agent something happened for a consumer, such as a payment. This can send a real WhatsApp message to the number in to. event.payload is a JSON string, not an object.

post/partner/app/{appId}/bizai/agent_event

Request

  • Base URL
    https://partner.gupshup.io
  • URL
    https://partner.gupshup.io/partner/app/{appId}/bizai/agent_event
  • Auth
    API key in header Authorization

Request body

tostring required

Consumer phone number, E.164. The consumer must already have a conversation with the business.

Example request

{
  "event": {
    "type": "payment_received"
  }
}

Response

Event accepted for processing.

status'accepted' required
agent_event_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.