Configurar webhook global
curl --request PUT \
--url https://cloud.datafyapi.com.br/channels/whatsapp/global-webhook \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://exemplo.com/webhook-global",
"events": [
"messages",
"smb_message_echoes"
],
"enabled": true
}
'const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://exemplo.com/webhook-global',
events: ['messages', 'smb_message_echoes'],
enabled: true
})
};
fetch('https://cloud.datafyapi.com.br/channels/whatsapp/global-webhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://cloud.datafyapi.com.br/channels/whatsapp/global-webhook"
payload = {
"url": "https://exemplo.com/webhook-global",
"events": ["messages", "smb_message_echoes"],
"enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"webhook": {
"url": "https://exemplo.com/webhook-global",
"events": [
"messages",
"smb_message_echoes"
],
"enabled": true,
"secret": "whsec_xxx"
}
}Webhook global
Configurar webhook global
Cria ou substitui o webhook global da conta. O corpo define o webhook inteiro: os campos omitidos voltam ao valor padrão.
PUT
/
channels
/
whatsapp
/
global-webhook
Configurar webhook global
curl --request PUT \
--url https://cloud.datafyapi.com.br/channels/whatsapp/global-webhook \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://exemplo.com/webhook-global",
"events": [
"messages",
"smb_message_echoes"
],
"enabled": true
}
'const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://exemplo.com/webhook-global',
events: ['messages', 'smb_message_echoes'],
enabled: true
})
};
fetch('https://cloud.datafyapi.com.br/channels/whatsapp/global-webhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://cloud.datafyapi.com.br/channels/whatsapp/global-webhook"
payload = {
"url": "https://exemplo.com/webhook-global",
"events": ["messages", "smb_message_echoes"],
"enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"webhook": {
"url": "https://exemplo.com/webhook-global",
"events": [
"messages",
"smb_message_echoes"
],
"enabled": true,
"secret": "whsec_xxx"
}
}O webhook global é um destino único que recebe os eventos de todos os canais de WhatsApp da conta, sem precisar configurar um webhook em cada canal.
Como funciona
- A conta tem um webhook global, apenas para WhatsApp.
- Ele funciona junto com os webhooks dos canais: um evento é entregue no webhook global e no webhook do canal. Se os dois apontam para a mesma URL, ela recebe o mesmo evento duas vezes, cada entrega assinada com o secret correspondente.
- As entregas são assinadas com o
secretdo próprio webhook global, no mesmo esquema de assinatura dos webhooks dos canais. O secret é gerado na primeira configuração e mantido nas substituições seguintes; para trocá-lo, use Rotacionar secret global.
Diferente da edição dos webhooks dos canais, esta chamada substitui o webhook inteiro. Campos omitidos voltam ao valor padrão:
events passa a ser messages e smb_message_echoes, e enabled passa a ser true.Resposta
| Campo | Descrição |
|---|---|
webhook.url | URL que recebe os eventos de todos os canais |
webhook.events | Eventos que o webhook recebe |
webhook.enabled | Indica se o webhook está ativo |
webhook.secret | Secret usado na assinatura das entregas deste webhook |
Autorizações
Token de conta gerado no painel da Datafy, em Perfil. Formato: sk_acct_xxx. Diferente do token de canal (sk_live_).
Corpo
application/json
URL que recebe os eventos de todos os canais. Precisa usar HTTPS.
Exemplo:
"https://exemplo.com/webhook-global"
Eventos que o webhook recebe. Se omitido, recebe messages e smb_message_echoes. Não pode ser uma lista vazia.
Opções disponíveis:
messages, smb_message_echoes, message_template_status_update, message_template_quality_update, message_template_components_update, account_alerts, account_update, account_review_update, account_settings_update, phone_number_name_update, phone_number_quality_update, business_capability_update, business_status_update, template_category_update, template_correct_category_detection, flows, calls, security, automatic_events, tracking_events, history, smb_app_state_sync, payment_configuration_update, partner_solutions, group_lifecycle_update, group_participants_update, group_settings_update, group_status_update, user_preferences Exemplo:
["messages", "smb_message_echoes"]
Ativa ou desativa o webhook. Se omitido, fica ativo.
Exemplo:
true
Resposta
Webhook global configurado.
Webhook global da conta, ou null quando não configurado.
Show child attributes
Show child attributes