Get agent event

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request parameters

ParameterTypeRequiredInDescription
AuthorizationstringYesHeaderPartner app token, sent raw. Bearer <token> is also accepted.
appIdstring (uuid)YesPathPartner Portal app id. Stands in for Meta's entity_id.
agentEventIdstringYesPathId returned by POST /agent_event. Meta pfbid… id.

Example request

curl --location --request GET 'https://partner.gupshup.io/partner/app/<appId>/bizai/agent_event/<agentEventId>' \
  --header 'Authorization: <PARTNER_APP_TOKEN>'

Response parameters — 200

ParameterTypeDescription
statusstringOne of: request_received, processing, sent, failed, skipped, success.
event_typestringEvent type as posted.
error_messagestringError text.
skipped_reasonstringWhy the event was skipped.
created_atstring (date-time)Creation time, Unix seconds.
updated_atstring (date-time)Last update time, Unix seconds.

Example response — 200 OK

{
  "status": "sent",
  "event_type": "payment_received",
  "created_at": "2026-09-24T10:00:00Z",
  "updated_at": "2026-09-24T10:00:03Z"
}

Error responses

400 Bad Request — The app is not live, or WASS does not consider it live.

{
  "message": "App is not live.",
  "status": "error"
}

400 Bad Request — The app has no phone number attached. Checked before the live check.

{
  "message": "Phone id not found for the given App",
  "status": "error"
}

401 Unauthorized — Authorization is missing or invalid, belongs to another app, or appId is unknown or not a UUID.

{
  "status": "error",
  "message": "Unauthorised access to the resource. Please review request parameters and headers and retry"
}

405 Method Not Allowed — Any method other than GET, POST, PUT or DELETE, e.g. PATCH.

{
  "status": "error",
  "message": "Request method 'PATCH' is not supported"
}

429 Too Many Requests — More than 30 /bizai/** requests in 60 seconds for this app. The 31st is rejected.

{
  "status": "error",
  "message": "Too Many Requests"
}
Path Params
uuid
required

Partner Portal app id. Stands in for Meta's entity_id.

string
required
^pfbid

Id returned by POST /agent_event.

Responses

429

Per-app rate limit exceeded. Retry after the 60-second window.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json