HypeConversa

Webhooks

Registrar webhook

Registra (ou atualiza) a URL de um evento. Retorna o secret uma única vez.

PUT
/instances/{INSTANCE_TOKEN}/webhooks

Atributos

Cabeçalho

Client-Tokenstringobrigatório

Token da conta. Envie o valor puro, sem o prefixo Bearer.

Corpo

eventstringobrigatório

message.received | message.status | connection.

urlstring (https)obrigatório

URL que receberá o POST assinado.

Resposta

200Veja o corpo de exemplo na referência.
Registrar webhook
curl --request PUT \
  --url https://api.hypeconversa.com/instances/{INSTANCE_TOKEN}/webhooks \
  --header 'Client-Token: SEU_TOKEN_DE_CONTA' \
  --header 'Content-Type: application/json' \
  --data '{ "event": "message.received", "url": "https://seu-sistema.com/hook" }'
200
json
{
  "event": "message.received",
  "url": "https://seu-sistema.com/hook",
  "secret": "whsec_..."
}