Skip to main content

​
Overview

In this topic we will talk about the webhook returns that we use. Z-API instances make POST requests for events they perform to the previously configured URL. For each request there is a specific JSON body that will be described next.
Your endpoint must accept a POST.

​
What is it and what is it for?

According to Google, a Webhook is a resource used on the internet for one application to communicate with another, providing real-time data whenever an event occurs. So if you are integrating with Z-API and need to receive information through the application, you need to provide these endpoints in your application so we can notify you about everything that happens on your application.

​
Our webhooks

Delivery

Notifies when your message was delivered to the application. This does not guarantee the contact received the message.

Receive

Triggered every time someone interacts with your number on the application.

Status

Informs message status changes (received, read, replied, deleted).

Disconnected

Triggered when there is unavailability in communication between phone-application or phone-Z-API.

​
How to configure my webhook?

​
Via Panel

Access the admin panel, navigate to Instances, click on the view icon of the desired instance and select “edit” in the three dots menu.

​
Via API

You can update the webhook route through the update endpoints described in the following topics of this documentation.