Skip to main content
PUT
/
instances
/
{instanceId}
/
token
/
{token}
/
update-webhook-delivery
On send
curl --request PUT \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/update-webhook-delivery \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<string>"
}
'
{
  "phone": "<string>",
  "zaapId": "<string>",
  "messageId": "<string>",
  "instanceId": "<string>",
  "momment": 123,
  "type": "<string>",
  "error": "<string>"
}

​
Overview

This is the webhook for sent message callbacks.
Z-API does not accept webhooks that are not HTTPS.

​
Update webhook

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

​
Body

​
value
string
required
Delivery webhook URL

​
Request Body

{
  "value": "https://your-system-address.com/instance/YOUR_INSTANCE/delivery"
}

​
Webhook Response

​
Response Attributes

​
phone
string
Destination phone number of the message
​
zaapId
string
Message identifier within the conversation
​
messageId
string
Message identifier on WhatsApp
​
instanceId
string
Instance identifier
​
momment
integer
Moment when the event was triggered (timestamp in milliseconds)
​
type
string
Type of the instance event, in this case it will be DeliveryCallback
​
error
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
{
  "phone": "554499999999",
  "zaapId": "A20DA9C0183A2D35A260F53F5D2B9244",
  "messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
  "instanceId": "instance.id",
  "momment": 1777494009341,
  "type": "DeliveryCallback"
}

​
Response

​
200

{
  "value": true
}

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