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 pelo número (API ou celular); MESSAGE.STATUS_UPDATED = uma mensagem enviada foi entregue ou lida; CONNECTION.UPDATED = o número conectou, desconectou, foi deslogado ou banido; QRCODE.UPDATED = QR Code de pareamento gerado ou expirado.

Opções disponíveis:
MESSAGE.RECEIVED,
MESSAGE.SENT,
MESSAGE.STATUS_UPDATED,
CONNECTION.UPDATED,
QRCODE.UPDATED
Exemplo:
enabled
boolean
padrão:true

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

Resposta

Webhook criado.

data
object

Webhook criado, com o segredo de assinatura.