Update webhook
curl --request PUT \
--url https://api.zappaz.io/api/v1/session/{sessionId}/webhook/{webhookId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"displayName": "<string>",
"enabled": true,
"events": {
"call": false,
"blocklist.set": false,
"blocklist.update": false,
"chats.delete": false,
"chats.phoneNumberShare": false,
"chats.update": false,
"chats.upsert": false,
"connection.update": false,
"contacts.update": false,
"contacts.upsert": false,
"creds.update": false,
"group-participants.update": false,
"group.join-request": false,
"groups.update": false,
"groups.upsert": false,
"labels.association": false,
"labels.edit": false,
"message-receipt.update": false,
"messages.delete": false,
"messages.media-update": false,
"messages.reaction": false,
"messages.send": false,
"messages.update": false,
"messaging-history.set": false,
"presence.update": false,
"inbound-message.upsert": false,
"outbound-message.upsert": false
},
"headers": {}
}
'import requests
url = "https://api.zappaz.io/api/v1/session/{sessionId}/webhook/{webhookId}"
payload = {
"url": "<string>",
"displayName": "<string>",
"enabled": True,
"events": {
"call": False,
"blocklist.set": False,
"blocklist.update": False,
"chats.delete": False,
"chats.phoneNumberShare": False,
"chats.update": False,
"chats.upsert": False,
"connection.update": False,
"contacts.update": False,
"contacts.upsert": False,
"creds.update": False,
"group-participants.update": False,
"group.join-request": False,
"groups.update": False,
"groups.upsert": False,
"labels.association": False,
"labels.edit": False,
"message-receipt.update": False,
"messages.delete": False,
"messages.media-update": False,
"messages.reaction": False,
"messages.send": False,
"messages.update": False,
"messaging-history.set": False,
"presence.update": False,
"inbound-message.upsert": False,
"outbound-message.upsert": False
},
"headers": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
displayName: '<string>',
enabled: true,
events: {
call: false,
'blocklist.set': false,
'blocklist.update': false,
'chats.delete': false,
'chats.phoneNumberShare': false,
'chats.update': false,
'chats.upsert': false,
'connection.update': false,
'contacts.update': false,
'contacts.upsert': false,
'creds.update': false,
'group-participants.update': false,
'group.join-request': false,
'groups.update': false,
'groups.upsert': false,
'labels.association': false,
'labels.edit': false,
'message-receipt.update': false,
'messages.delete': false,
'messages.media-update': false,
'messages.reaction': false,
'messages.send': false,
'messages.update': false,
'messaging-history.set': false,
'presence.update': false,
'inbound-message.upsert': false,
'outbound-message.upsert': false
},
headers: {}
})
};
fetch('https://api.zappaz.io/api/v1/session/{sessionId}/webhook/{webhookId}', 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.zappaz.io/api/v1/session/{sessionId}/webhook/{webhookId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'displayName' => '<string>',
'enabled' => true,
'events' => [
'call' => false,
'blocklist.set' => false,
'blocklist.update' => false,
'chats.delete' => false,
'chats.phoneNumberShare' => false,
'chats.update' => false,
'chats.upsert' => false,
'connection.update' => false,
'contacts.update' => false,
'contacts.upsert' => false,
'creds.update' => false,
'group-participants.update' => false,
'group.join-request' => false,
'groups.update' => false,
'groups.upsert' => false,
'labels.association' => false,
'labels.edit' => false,
'message-receipt.update' => false,
'messages.delete' => false,
'messages.media-update' => false,
'messages.reaction' => false,
'messages.send' => false,
'messages.update' => false,
'messaging-history.set' => false,
'presence.update' => false,
'inbound-message.upsert' => false,
'outbound-message.upsert' => false
],
'headers' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zappaz.io/api/v1/session/{sessionId}/webhook/{webhookId}"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"displayName\": \"<string>\",\n \"enabled\": true,\n \"events\": {\n \"call\": false,\n \"blocklist.set\": false,\n \"blocklist.update\": false,\n \"chats.delete\": false,\n \"chats.phoneNumberShare\": false,\n \"chats.update\": false,\n \"chats.upsert\": false,\n \"connection.update\": false,\n \"contacts.update\": false,\n \"contacts.upsert\": false,\n \"creds.update\": false,\n \"group-participants.update\": false,\n \"group.join-request\": false,\n \"groups.update\": false,\n \"groups.upsert\": false,\n \"labels.association\": false,\n \"labels.edit\": false,\n \"message-receipt.update\": false,\n \"messages.delete\": false,\n \"messages.media-update\": false,\n \"messages.reaction\": false,\n \"messages.send\": false,\n \"messages.update\": false,\n \"messaging-history.set\": false,\n \"presence.update\": false,\n \"inbound-message.upsert\": false,\n \"outbound-message.upsert\": false\n },\n \"headers\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.zappaz.io/api/v1/session/{sessionId}/webhook/{webhookId}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"displayName\": \"<string>\",\n \"enabled\": true,\n \"events\": {\n \"call\": false,\n \"blocklist.set\": false,\n \"blocklist.update\": false,\n \"chats.delete\": false,\n \"chats.phoneNumberShare\": false,\n \"chats.update\": false,\n \"chats.upsert\": false,\n \"connection.update\": false,\n \"contacts.update\": false,\n \"contacts.upsert\": false,\n \"creds.update\": false,\n \"group-participants.update\": false,\n \"group.join-request\": false,\n \"groups.update\": false,\n \"groups.upsert\": false,\n \"labels.association\": false,\n \"labels.edit\": false,\n \"message-receipt.update\": false,\n \"messages.delete\": false,\n \"messages.media-update\": false,\n \"messages.reaction\": false,\n \"messages.send\": false,\n \"messages.update\": false,\n \"messaging-history.set\": false,\n \"presence.update\": false,\n \"inbound-message.upsert\": false,\n \"outbound-message.upsert\": false\n },\n \"headers\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zappaz.io/api/v1/session/{sessionId}/webhook/{webhookId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"displayName\": \"<string>\",\n \"enabled\": true,\n \"events\": {\n \"call\": false,\n \"blocklist.set\": false,\n \"blocklist.update\": false,\n \"chats.delete\": false,\n \"chats.phoneNumberShare\": false,\n \"chats.update\": false,\n \"chats.upsert\": false,\n \"connection.update\": false,\n \"contacts.update\": false,\n \"contacts.upsert\": false,\n \"creds.update\": false,\n \"group-participants.update\": false,\n \"group.join-request\": false,\n \"groups.update\": false,\n \"groups.upsert\": false,\n \"labels.association\": false,\n \"labels.edit\": false,\n \"message-receipt.update\": false,\n \"messages.delete\": false,\n \"messages.media-update\": false,\n \"messages.reaction\": false,\n \"messages.send\": false,\n \"messages.update\": false,\n \"messaging-history.set\": false,\n \"presence.update\": false,\n \"inbound-message.upsert\": false,\n \"outbound-message.upsert\": false\n },\n \"headers\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"url": "<string>",
"displayName": "<string>",
"enabled": true,
"events": {
"call": false,
"blocklist.set": false,
"blocklist.update": false,
"chats.delete": false,
"chats.phoneNumberShare": false,
"chats.update": false,
"chats.upsert": false,
"connection.update": false,
"contacts.update": false,
"contacts.upsert": false,
"creds.update": false,
"group-participants.update": false,
"group.join-request": false,
"groups.update": false,
"groups.upsert": false,
"labels.association": false,
"labels.edit": false,
"message-receipt.update": false,
"messages.delete": false,
"messages.media-update": false,
"messages.reaction": false,
"messages.send": false,
"messages.update": false,
"messaging-history.set": false,
"presence.update": false,
"inbound-message.upsert": false,
"outbound-message.upsert": false
},
"headers": {},
"createdAt": "2023-11-07T05:31:56Z",
"waSessionId": "<string>"
}
}{
"status": "failed",
"message": "<string>"
}{
"status": "failed",
"message": "<string>"
}{
"status": "failed",
"message": "<string>"
}Webhooks
Update webhook
Atualiza um webhook existente para a sessão especificada
PUT
/
session
/
{sessionId}
/
webhook
/
{webhookId}
Update webhook
curl --request PUT \
--url https://api.zappaz.io/api/v1/session/{sessionId}/webhook/{webhookId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"displayName": "<string>",
"enabled": true,
"events": {
"call": false,
"blocklist.set": false,
"blocklist.update": false,
"chats.delete": false,
"chats.phoneNumberShare": false,
"chats.update": false,
"chats.upsert": false,
"connection.update": false,
"contacts.update": false,
"contacts.upsert": false,
"creds.update": false,
"group-participants.update": false,
"group.join-request": false,
"groups.update": false,
"groups.upsert": false,
"labels.association": false,
"labels.edit": false,
"message-receipt.update": false,
"messages.delete": false,
"messages.media-update": false,
"messages.reaction": false,
"messages.send": false,
"messages.update": false,
"messaging-history.set": false,
"presence.update": false,
"inbound-message.upsert": false,
"outbound-message.upsert": false
},
"headers": {}
}
'import requests
url = "https://api.zappaz.io/api/v1/session/{sessionId}/webhook/{webhookId}"
payload = {
"url": "<string>",
"displayName": "<string>",
"enabled": True,
"events": {
"call": False,
"blocklist.set": False,
"blocklist.update": False,
"chats.delete": False,
"chats.phoneNumberShare": False,
"chats.update": False,
"chats.upsert": False,
"connection.update": False,
"contacts.update": False,
"contacts.upsert": False,
"creds.update": False,
"group-participants.update": False,
"group.join-request": False,
"groups.update": False,
"groups.upsert": False,
"labels.association": False,
"labels.edit": False,
"message-receipt.update": False,
"messages.delete": False,
"messages.media-update": False,
"messages.reaction": False,
"messages.send": False,
"messages.update": False,
"messaging-history.set": False,
"presence.update": False,
"inbound-message.upsert": False,
"outbound-message.upsert": False
},
"headers": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
displayName: '<string>',
enabled: true,
events: {
call: false,
'blocklist.set': false,
'blocklist.update': false,
'chats.delete': false,
'chats.phoneNumberShare': false,
'chats.update': false,
'chats.upsert': false,
'connection.update': false,
'contacts.update': false,
'contacts.upsert': false,
'creds.update': false,
'group-participants.update': false,
'group.join-request': false,
'groups.update': false,
'groups.upsert': false,
'labels.association': false,
'labels.edit': false,
'message-receipt.update': false,
'messages.delete': false,
'messages.media-update': false,
'messages.reaction': false,
'messages.send': false,
'messages.update': false,
'messaging-history.set': false,
'presence.update': false,
'inbound-message.upsert': false,
'outbound-message.upsert': false
},
headers: {}
})
};
fetch('https://api.zappaz.io/api/v1/session/{sessionId}/webhook/{webhookId}', 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.zappaz.io/api/v1/session/{sessionId}/webhook/{webhookId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'displayName' => '<string>',
'enabled' => true,
'events' => [
'call' => false,
'blocklist.set' => false,
'blocklist.update' => false,
'chats.delete' => false,
'chats.phoneNumberShare' => false,
'chats.update' => false,
'chats.upsert' => false,
'connection.update' => false,
'contacts.update' => false,
'contacts.upsert' => false,
'creds.update' => false,
'group-participants.update' => false,
'group.join-request' => false,
'groups.update' => false,
'groups.upsert' => false,
'labels.association' => false,
'labels.edit' => false,
'message-receipt.update' => false,
'messages.delete' => false,
'messages.media-update' => false,
'messages.reaction' => false,
'messages.send' => false,
'messages.update' => false,
'messaging-history.set' => false,
'presence.update' => false,
'inbound-message.upsert' => false,
'outbound-message.upsert' => false
],
'headers' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zappaz.io/api/v1/session/{sessionId}/webhook/{webhookId}"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"displayName\": \"<string>\",\n \"enabled\": true,\n \"events\": {\n \"call\": false,\n \"blocklist.set\": false,\n \"blocklist.update\": false,\n \"chats.delete\": false,\n \"chats.phoneNumberShare\": false,\n \"chats.update\": false,\n \"chats.upsert\": false,\n \"connection.update\": false,\n \"contacts.update\": false,\n \"contacts.upsert\": false,\n \"creds.update\": false,\n \"group-participants.update\": false,\n \"group.join-request\": false,\n \"groups.update\": false,\n \"groups.upsert\": false,\n \"labels.association\": false,\n \"labels.edit\": false,\n \"message-receipt.update\": false,\n \"messages.delete\": false,\n \"messages.media-update\": false,\n \"messages.reaction\": false,\n \"messages.send\": false,\n \"messages.update\": false,\n \"messaging-history.set\": false,\n \"presence.update\": false,\n \"inbound-message.upsert\": false,\n \"outbound-message.upsert\": false\n },\n \"headers\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.zappaz.io/api/v1/session/{sessionId}/webhook/{webhookId}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"displayName\": \"<string>\",\n \"enabled\": true,\n \"events\": {\n \"call\": false,\n \"blocklist.set\": false,\n \"blocklist.update\": false,\n \"chats.delete\": false,\n \"chats.phoneNumberShare\": false,\n \"chats.update\": false,\n \"chats.upsert\": false,\n \"connection.update\": false,\n \"contacts.update\": false,\n \"contacts.upsert\": false,\n \"creds.update\": false,\n \"group-participants.update\": false,\n \"group.join-request\": false,\n \"groups.update\": false,\n \"groups.upsert\": false,\n \"labels.association\": false,\n \"labels.edit\": false,\n \"message-receipt.update\": false,\n \"messages.delete\": false,\n \"messages.media-update\": false,\n \"messages.reaction\": false,\n \"messages.send\": false,\n \"messages.update\": false,\n \"messaging-history.set\": false,\n \"presence.update\": false,\n \"inbound-message.upsert\": false,\n \"outbound-message.upsert\": false\n },\n \"headers\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zappaz.io/api/v1/session/{sessionId}/webhook/{webhookId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"displayName\": \"<string>\",\n \"enabled\": true,\n \"events\": {\n \"call\": false,\n \"blocklist.set\": false,\n \"blocklist.update\": false,\n \"chats.delete\": false,\n \"chats.phoneNumberShare\": false,\n \"chats.update\": false,\n \"chats.upsert\": false,\n \"connection.update\": false,\n \"contacts.update\": false,\n \"contacts.upsert\": false,\n \"creds.update\": false,\n \"group-participants.update\": false,\n \"group.join-request\": false,\n \"groups.update\": false,\n \"groups.upsert\": false,\n \"labels.association\": false,\n \"labels.edit\": false,\n \"message-receipt.update\": false,\n \"messages.delete\": false,\n \"messages.media-update\": false,\n \"messages.reaction\": false,\n \"messages.send\": false,\n \"messages.update\": false,\n \"messaging-history.set\": false,\n \"presence.update\": false,\n \"inbound-message.upsert\": false,\n \"outbound-message.upsert\": false\n },\n \"headers\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"url": "<string>",
"displayName": "<string>",
"enabled": true,
"events": {
"call": false,
"blocklist.set": false,
"blocklist.update": false,
"chats.delete": false,
"chats.phoneNumberShare": false,
"chats.update": false,
"chats.upsert": false,
"connection.update": false,
"contacts.update": false,
"contacts.upsert": false,
"creds.update": false,
"group-participants.update": false,
"group.join-request": false,
"groups.update": false,
"groups.upsert": false,
"labels.association": false,
"labels.edit": false,
"message-receipt.update": false,
"messages.delete": false,
"messages.media-update": false,
"messages.reaction": false,
"messages.send": false,
"messages.update": false,
"messaging-history.set": false,
"presence.update": false,
"inbound-message.upsert": false,
"outbound-message.upsert": false
},
"headers": {},
"createdAt": "2023-11-07T05:31:56Z",
"waSessionId": "<string>"
}
}{
"status": "failed",
"message": "<string>"
}{
"status": "failed",
"message": "<string>"
}{
"status": "failed",
"message": "<string>"
}Authorizations
Token de usuário ou sessão, passado diretamente como uma string no cabeçalho 'Authorization'. O token de usuário tem escopo sobre todas as sessões pertencentes ao usuário. O token de sessão é limitado à própria sessão.
Path Parameters
Identificador único da sessão
Identificador único do webhook
Body
application/json
URL where webhook events will be sent
Optional display name for the webhook
Whether the webhook is active
Configuration of which events this webhook subscribes to
Show child attributes
Show child attributes
Custom headers to be sent with webhook requests
Show child attributes
Show child attributes
⌘I

