Skip to main content
POST
/
v1
/
webhooks
Criar webhook
curl --request POST \
  --url https://api.notifique.dev/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Meu webhook",
  "url": "https://api.seudominio.com/receive",
  "events": [
    "message.sent",
    "message.delivered",
    "instance.qrcode"
  ],
  "instanceIds": []
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "workspaceId": "<string>",
    "name": "<string>",
    "url": "<string>",
    "secret": "<string>",
    "events": [
      "<string>"
    ],
    "instanceIds": [
      "<string>"
    ],
    "enabled": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Authorization: Bearer sk_live_xxxxx

Body

application/json
name
string
required
Maximum string length: 1024
url
string<uri>
required
Maximum string length: 2048
events
string[]
required
Minimum array length: 1
Maximum string length: 64
instanceIds
string[]

Response

Webhook criado; inclui secret (use para validar assinatura HMAC).

success
boolean
required
Example:

true

data
object
required