Pular para o conteúdo principal
POST
/
instances
/
{id}
/
webhooks
Criar webhook
curl --request POST \
  --url https://api.zapfy.io/v1/instances/{id}/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://seu-app.com/webhooks",
  "events": [
    "MESSAGE_RECEIVED",
    "MESSAGE_STATUS"
  ],
  "enabled": true
}
'
{
  "data": {
    "id": "01J9Z...",
    "url": "https://seu-app.com/webhooks",
    "events": [],
    "enabled": true,
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

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
Exemplo:

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

events
enum<string>[]
obrigatório
Minimum array length: 1
Opções disponíveis:
MESSAGE_RECEIVED,
MESSAGE_SENT,
MESSAGE_STATUS,
CONNECTION_UPDATE,
QRCODE_UPDATED
Exemplo:
["MESSAGE_RECEIVED", "MESSAGE_STATUS"]
enabled
boolean
padrão:true

Resposta

Webhook criado.

data
object