Skip to main content
PUT
Message status

Overview

This is the message status callback webhook.
Z-API does not accept webhooks that are not HTTPS.

Update webhook

string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.

Body

string
required
Message status webhook URL

Request Body


Webhook callback

string
Instance identifier
string
Message status: SENT, RECEIVED, READ, READ_BY_ME or PLAYED
array
Message identifier(s)
integer
Event timestamp
integer
Device type (0 = mobile)
string
Destination phone number
string
Event type: MessageStatusCallback
boolean
Whether the chat is a group

Response

200

405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or PUT as specified at the beginning of this topic.

415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.