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

​
Overview

This is the disconnection response webhook.
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
Disconnection webhook URL

​
Request Body

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

​
Webhook callback

​
momment
integer
Timestamp of the disconnection moment
​
error
string
Error description that caused the disconnection
​
disconnected
boolean
Connection status indicator
​
type
string
Event type: DisconnectedCallback
​
instanceId
string
Instance identifier
{
  "momment": 1580163342,
  "error": "Device has been disconnected",
  "disconnected": true,
  "type": "DisconnectedCallback",
  "instanceId": "instance.id"
}

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