Ver Webhook da Instância
curl --request GET \
--url https://api.zappfy.io/webhook \
--header 'token: <api-key>'import requests
url = "https://api.zappfy.io/webhook"
headers = {"token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {token: '<api-key>'}};
fetch('https://api.zappfy.io/webhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zappfy.io/webhook",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zappfy.io/webhook"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zappfy.io/webhook")
.header("token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zappfy.io/webhook")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["token"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"enabled": true,
"url": "https://example.com/webhook",
"events": [
"messages",
"messages_update"
],
"excludeMessages": [
"wasSentByApi",
"isGroupNo"
],
"addUrlEvents": true,
"addUrlTypesMessages": true
},
{
"id": "987fcdeb-51k3-09j8-x543-864297539100",
"enabled": true,
"url": "https://outro-endpoint.com/webhook",
"events": [
"connection",
"presence"
],
"excludeMessages": [],
"addUrlEvents": false,
"addUrlTypesMessages": false
}
]{
"error": "missing token"
}{
"error": "Failed to process webhook data"
}Webhooks e SSE
Ver Webhook da Instância
Retorna a configuração atual do webhook da instância, incluindo:
- URL configurada
- Eventos ativos
- Filtros aplicados
- Configurações adicionais
Exemplo de resposta:
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"enabled": true,
"url": "https://example.com/webhook",
"events": ["messages", "messages_update"],
"excludeMessages": ["wasSentByApi", "isGroupNo"],
"addUrlEvents": true,
"addUrlTypesMessages": true
},
{
"id": "987fcdeb-51k3-09j8-x543-864297539100",
"enabled": true,
"url": "https://outro-endpoint.com/webhook",
"events": ["connection", "presence"],
"excludeMessages": [],
"addUrlEvents": false,
"addUrlTypesMessages": false
}
]
A resposta é sempre um array, mesmo quando há apenas um webhook configurado.
GET
/
webhook
Ver Webhook da Instância
curl --request GET \
--url https://api.zappfy.io/webhook \
--header 'token: <api-key>'import requests
url = "https://api.zappfy.io/webhook"
headers = {"token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {token: '<api-key>'}};
fetch('https://api.zappfy.io/webhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zappfy.io/webhook",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zappfy.io/webhook"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zappfy.io/webhook")
.header("token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zappfy.io/webhook")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["token"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"enabled": true,
"url": "https://example.com/webhook",
"events": [
"messages",
"messages_update"
],
"excludeMessages": [
"wasSentByApi",
"isGroupNo"
],
"addUrlEvents": true,
"addUrlTypesMessages": true
},
{
"id": "987fcdeb-51k3-09j8-x543-864297539100",
"enabled": true,
"url": "https://outro-endpoint.com/webhook",
"events": [
"connection",
"presence"
],
"excludeMessages": [],
"addUrlEvents": false,
"addUrlTypesMessages": false
}
]{
"error": "missing token"
}{
"error": "Failed to process webhook data"
}Autorizações
Resposta
Configuração do webhook retornada com sucesso
URL de destino dos eventos
Tipos de eventos monitorados
Opções disponíveis:
connection, history, messages, messages_update, call, contacts, presence, groups, labels, chats, chat_labels, blocks, leads ID único gerado automaticamente
ID da instância associada
Webhook ativo/inativo
Incluir na URLs o tipo de mensagem
Incluir na URL o nome do evento
Filtros para excluir tipos de mensagens
Opções disponíveis:
wasSentByApi, wasNotSentByApi, fromMeYes, fromMeNo, isGroupYes, IsGroupNo Data de criação (automática)
Data da última atualização (automática)

