Skip to main content
PUT
On send

Overview

This is the webhook for sent message callbacks.
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
Delivery webhook URL

Request Body


Webhook Response

Response Attributes

string
Destination phone number of the message
string
Message identifier within the conversation
string
Message identifier on WhatsApp
string
Instance identifier
integer
Moment when the event was triggered (timestamp in milliseconds)
string
Type of the instance event, in this case it will be DeliveryCallback
string
Present only in error cases. Contains the description of the error that occurred when sending the message. Check the full list of possible errors in On Send callback examples

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”.