Pular para o conteúdo principal
GET
Consultar um endpoint de webhook

Autorizações

Authorization
string
header
obrigatório

Autentique com uma chave secreta (sk_live_…) ou uma chave restrita (rk_live_…) criada no painel. Chaves restritas só têm as permissões escolhidas na criação, como messages:send, chats:read ou broadcasts:send.

Cabeçalhos

Blu-Version
string

A versão da API a usar. Por padrão, é a versão fixada na sua conta.

Exemplo:

"2026-10-11"

Parâmetros de caminho

webhook_endpoint
string
obrigatório
Pattern: ^we_

Resposta

O endpoint de webhook.

id
string
obrigatório
Pattern: ^we_
Exemplo:

"we_3Mx9"

object
string
obrigatório
Allowed value: "webhook_endpoint"
url
string<uri>
obrigatório
enabled_events
(enum<string> | string)[]
obrigatório

Tipos de evento a enviar, ou ["*"] para todos.

Minimum array length: 1
  • message.received: chegou uma mensagem. data.object é a mensagem.
  • message.updated: o status de uma mensagem enviada mudou. data.object é a mensagem.
  • phone_number.connected / phone_number.disconnected: data.object é o número.
  • broadcast.completed / broadcast.failed: data.object é a campanha.
Opções disponíveis:
message.received,
message.updated,
phone_number.connected,
phone_number.disconnected,
broadcast.completed,
broadcast.failed
status
enum<string>
obrigatório
Opções disponíveis:
enabled,
disabled
description
string | null
obrigatório
api_version
string
obrigatório

A versão da API usada para montar os eventos.

created
integer
obrigatório

Horário Unix em segundos.

Exemplo:

1760190012

metadata
object
obrigatório

Até 50 pares de chave e valor seus. Chaves com até 40 caracteres e valores com até 500.

secret
string

O segredo de assinatura. Só é devolvido quando o endpoint é criado.

Exemplo:

"whsec_7f2b…"