Pular para o conteúdo principal
POST
/
api
/
webhooks
Criar um novo endpoint de webhook
curl --request POST \
  --url https://api.wappfy.io/api/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/webhook",
  "events": [
    "message.received",
    "message.sent"
  ],
  "secret": "<string>",
  "description": "<string>",
  "instance_id": "<string>",
  "headers": {
    "X-Custom": "value"
  },
  "retry_count": 3,
  "timeout_ms": 5000
}
'
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "user_id": "<string>",
  "url": "https://example.com/webhook",
  "events": [
    "message.received",
    "message.sent"
  ],
  "retry_count": 3,
  "timeout_ms": 5000,
  "is_active": true,
  "created_at": "<string>",
  "updated_at": "<string>",
  "secret": "<string>",
  "description": "Production webhook",
  "instance_id": "<string>",
  "headers": {}
}

Autorizações

​
Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corpo

application/json
​
url
string
obrigatório
Exemplo:

"https://example.com/webhook"

​
events
enum<string>[]
obrigatório
Opções disponíveis:
message.received,
message.sent,
message.delivered,
message.read,
message.failed,
message.reaction,
instance.connected,
instance.disconnected,
instance.qr,
contact.created,
group.joined,
group.left
Exemplo:
["message.received", "message.sent"]
​
secret
string

Segredo HMAC para verificação de assinaturas de webhook

​
description
string
​
instance_id
string

Escopo para uma instância específica. NULL = global (todas as instâncias).

​
headers
object

Headers HTTP personalizados enviados com cada entrega

Exemplo:
{ "X-Custom": "value" }
​
retry_count
number
padrão:3
​
timeout_ms
number
padrão:5000

Resposta

Endpoint de webhook criado

​
id
string
obrigatório

Webhook endpoint UUID

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
user_id
string
obrigatório

ID do usuário proprietário

​
url
string
obrigatório

URL de destino

Exemplo:

"https://example.com/webhook"

​
events
string[]
obrigatório

Tipos de eventos inscritos

Exemplo:
["message.received", "message.sent"]
​
retry_count
number
obrigatório

Máximo de tentativas de retry em falha

Exemplo:

3

​
timeout_ms
number
obrigatório

Timeout da requisição em milissegundos

Exemplo:

5000

​
is_active
boolean
obrigatório

Se o endpoint está ativo

Exemplo:

true

​
created_at
string
obrigatório

Timestamp de criação

​
updated_at
string
obrigatório

Timestamp da última atualização

​
secret
string

HMAC secret for signature verification

​
description
string

Descrição legível

Exemplo:

"Production webhook"

​
instance_id
string

Scoped instance ID (null = all instances)

​
headers
object

Headers HTTP personalizados enviados com cada entrega