Skip to main content
POST
Criar webhook

Autorizações

Authorization
string
header
obrigatório

Token de conta (zpfy_acct_...) — gerencia instâncias e webhooks.

Parâmetros de caminho

id
string
obrigatório

ID da instância.

Corpo

application/json
url
string<uri>
obrigatório

URL HTTPS que receberá os eventos via POST.

Exemplo:

"https://seu-app.com/webhooks"

events
enum<string>[]
obrigatório

Eventos que disparam o webhook.

Minimum array length: 1

Tipo de evento. MESSAGE_RECEIVED = mensagem recebida; MESSAGE_SENT = mensagem enviada pela instância; MESSAGE_STATUS = mudança de status de entrega/leitura; CONNECTION_UPDATE = mudança na conexão da instância; QRCODE_UPDATED = novo QR Code para parear.

Opções disponíveis:
MESSAGE_RECEIVED,
MESSAGE_SENT,
MESSAGE_STATUS,
CONNECTION_UPDATE,
QRCODE_UPDATED
Exemplo:
enabled
boolean
padrão:true

Se o webhook está ativo. Padrão: true.

Resposta

Webhook criado.

data
object