Request Parameters

Key

Description

Value

Data type

Required/Optional

Constraints

Authorization

Access Token for the application

{{PARTNER_APP_TOKEN}}

String

Required

Should be a valid Partner App Access Token

appId

Id of the app for

whichcallback to be set

{{APP_ID}}

String

Required

The Id should be a valid app Id of Gupshup.
It should belong to the sameaccount as the apikey.
Required

Sample Request

curl --location 'https://partner.gupshup.io/partner/app/{{APP_ID}}/v1/event' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data ' 
	{
		"type": "message-event",
		"message": 
		{
			"messaging_product": "whatsapp",
			"status": "read",
			"message_id": "{{INCOMING_MESSAGE_ID}}",
			"typing_indicator": 
			{
				"type": "text"
			}
		}
	}'

Sample Response

{
	"status": "success"
}

Status Codes

Status Code	Response	Comments
Success
200	{ "status": "success"}
Error
400	{ "message": "Outbound event not supported","status": "error"}	Invalid status
400	{ "message": "Outbound event not supported","status": "error"}	Invalid payload
400	{ "message": "Invalid JSON payload","status": "error"}	Malformed json
400	{ "status": "error","message": "Please review the request parameters and retry"}	incorrect params

200Success

400Invalid JSON payload

429Too Many Requests

500Internal server error