Configs

Gerenciar configurações da conta, incluindo a URL do webhook para receber notificações em tempo real.

Obter configuração do webhook

get

Recupera a URL do webhook configurada para a conta WhatsApp Business. O endpoint de webhook recebe notificações em tempo real sobre eventos.

Eventos do Webhook

O webhook recebe notificações para:

Tipo de Evento	Descrição
messages	Mensagens recebidas de usuários
message_status	Atualizações de status de entrega (sent, delivered, read, failed)
message_template_status	Notificações de aprovação ou rejeição de templates
phone_number_quality_update	Alterações na classificação de qualidade do número
phone_number_name_update	Status de aprovação do nome de exibição
account_alerts	Notificações em nível de conta
flows	Eventos e respostas de WhatsApp Flows

Formato do Payload do Webhook

Todos os payloads de webhook seguem a estrutura JSON padrão com os campos object e entry.

Autorizações

ApiKeyAuth

apikeystringObrigatório

Chave de API para autenticação

Respostas

200

URL do webhook recuperada com sucesso

application/json

urlstring · uriOpcional

URL do webhook atualmente configurada

401

Não autorizado.

application/json

get

/configs/webhook

HTTPcURLJavaScriptPython

GET /v1/configs/webhook HTTP/1.1
Host: waba.fortics.com.br
apikey: YOUR_API_KEY
Accept: */*

{
  "url": "https://someurl.com/webhook"
}

Definir configuração do webhook

post

Configura a URL do webhook para receber notificações em tempo real do WhatsApp. O endpoint do webhook deve estar acessível publicamente e configurado corretamente.

Autorizações

ApiKeyAuth

apikeystringObrigatório

Chave de API para autenticação

Corpo

application/json

urlstring · uriObrigatório

URL HTTPS para envio dos eventos de webhook. Deve ser publicamente acessível e possuir certificado SSL válido.

Example: https://yourserver.com/webhook

Respostas

201

Recurso criado com sucesso

400

URL de webhook inválida

application/json

401

Não autorizado.

application/json

post

/configs/webhook

HTTPcURLJavaScriptPython

POST /v1/configs/webhook HTTP/1.1
Host: waba.fortics.com.br
apikey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "url": "https://someurl.com/webhook/new"
}

Sem conteúdo