Webhook events

In the API you ask; with webhooks Notifique notifies you. Ideal for syncing CRM, audit trails, or alerts when a send is blocked.

In brief

Every delivery is a POST application/json to your registered URL.
Three main events: list entry, list removal, and blocked send.
Respond 2xx quickly; heavy processing goes to a queue on your side.

General setup: Webhooks. Security (HMAC): Webhook security.

How the POST arrives

{
  "event": "suppression.added",
  "workspaceId": "clxx123...",
  "instanceId": "",
  "timestamp": "2025-08-01T10:00:00.000Z",
  "data": {
    "suppressionId": "clsup456...",
    "type": "phone",
    "value": "+5511999990000",
    "reason": "opt_out",
    "origin": "system",
    "channels": ["sms", "whatsapp", "rcs", "voice"],
    "contactId": "clcontact789..."
  }
}

Field	Description
`event`	Event name (e.g. `suppression.added`)
`workspaceId`	Workspace ID
`timestamp`	ISO 8601
`data`	Suppression or blocked-send details

Headers: X-Notifique-Signature, X-Notifique-Timestamp, X-Workspace-Id, X-Webhook-Event.

What your server should respond

Response	Effect
2xx within ~10s	Event delivered; removed from queue
4xx / 5xx / timeout	Automatic retry (5 min, 30 min, 2 h)

Slow processing? Respond 200 right away and process in the background.

Event reference

Event	When it fires	What to do with it
`suppression.added`	Identity becomes active on the list	Update CRM, log audit trail
`suppression.removed`	Active entry was removed	Re-enable contact flows in your system
`message.suppressed`	Send blocked by suppression	Mark attempt as `RECIPIENT_SUPPRESSED`, do not retry blindly

Prefer message.suppressed for all channels.

Idempotent addition does not fire duplicate suppression.added for the same active identity.

Payload per event

suppression.added

{
  "event": "suppression.added",
  "data": {
    "suppressionId": "clsup456...",
    "type": "email",
    "value": "cliente@example.com",
    "reason": "bounce",
    "origin": "provider",
    "channels": ["email"],
    "contactId": null
  }
}

suppression.removed

{
  "event": "suppression.removed",
  "data": {
    "suppressionId": "clsup456...",
    "type": "phone",
    "value": "+5511999990000",
    "reason": "manual",
    "origin": "api"
  }
}

message.suppressed

Fired when an individual or campaign send is blocked before spending credit or calling the provider.

{
  "event": "message.suppressed",
  "data": {
    "messageId": "clmsg123...",
    "type": "phone",
    "value": "+5511999990000",
    "channel": "whatsapp",
    "code": "RECIPIENT_SUPPRESSED",
    "suppressionId": "clsup456..."
  }
}

Next steps

Introduction: difference between suppression and unsubscribe
Quick Start: add and remove via API
Troubleshooting: error codes

API E-mail

E-mail

Domínios

E-mails recebidos

In brief

How the POST arrives

What your server should respond

Event reference

Payload per event

Next steps

​In brief

​How the POST arrives

​What your server should respond

​Event reference

​Payload per event

​Next steps

In brief

How the POST arrives

What your server should respond

Event reference

Payload per event

Next steps