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

​
Overview

This is the phone connection callback webhook with Z-API. It’s triggered when Z-API connects to WhatsApp — during QR code reading, instance restart, etc.
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
Connection webhook URL

​
Request Body

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

​
Webhook callback

​
type
string
Event type: ConnectedCallback
​
connected
boolean
Instance connection status
​
phone
string
Connected phone number
​
momment
integer
Connection timestamp
​
instanceId
string
Instance identifier
{
  "type": "ConnectedCallback",
  "connected": true,
  "momment": 26151515154,
  "instanceId": "instance.id",
  "phone": "5544999999999"
}

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