Webhook Events

With the API you ask; with webhooks Notifique tells you. Ideal to mark campaigns delivered or measure button clicks without polling.

In short

Every delivery is a POST application/json to your registered URL.
rcs.* events are RCS only; SMS uses sms.*, WhatsApp uses message.*.
instanceId carries the RCS agent ID when the send used a branded instance; empty on shared sender.
Enable only the events your integration uses.
Respond 2xx quickly; heavy processing goes to your queue.

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

POST shape

{
  "event": "rcs.delivered",
  "workspaceId": "clxx123...",
  "instanceId": "inst_rcs_abc123",
  "timestamp": "2025-02-10T14:30:00.000Z",
  "data": {
    "rcsId": "clxx456...",
    "to": "5511999999999",
    "status": "DELIVERED",
    "deliveredAt": "2025-02-10T14:30:05.000Z"
  }
}

Field	Description
`event`	Event name (e.g. `rcs.delivered`)
`workspaceId`	Workspace ID
`instanceId`	Branded RCS agent ID, or empty on shared sender
`timestamp`	ISO 8601, use for anti-replay
`data`	Send fields (`rcsId`, `to`, `status`, etc.)

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

What your server should return

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

Slow processing? Return 200 immediately and process in background.

Event reference

Event	When it fires	What to do
`rcs.sent`	RCS accepted and sent to network	Mark as sent
`rcs.delivered`	Delivered on device	Confirm delivery
`rcs.clicked`	Short-link or button click	Campaign / conversion
`rcs.failed`	Failure (no RCS, inactive instance, etc.)	SMS fallback or alert
`rcs.cancelled`	Scheduled send cancelled	Update queue

Payload per event

rcs.sent

{
  "event": "rcs.sent",
  "workspaceId": "clxx123...",
  "instanceId": "inst_rcs_abc123",
  "timestamp": "2025-02-10T14:29:00.000Z",
  "data": {
    "rcsId": "clxx456...",
    "to": "5511999999999",
    "status": "SENT",
    "sentAt": "2025-02-10T14:29:00.000Z",
    "messageType": "CARD",
    "payload": { "cardTitle": "Offer" }
  }
}

rcs.delivered

{
  "event": "rcs.delivered",
  "workspaceId": "clxx123...",
  "instanceId": "inst_rcs_abc123",
  "timestamp": "2025-02-10T14:30:00.000Z",
  "data": {
    "rcsId": "clxx456...",
    "to": "5511999999999",
    "status": "DELIVERED",
    "deliveredAt": "2025-02-10T14:30:05.000Z"
  }
}

rcs.clicked

Fired on the first tracked short-link or button click for this send.

{
  "event": "rcs.clicked",
  "workspaceId": "clxx123...",
  "instanceId": "",
  "timestamp": "2025-02-10T14:35:00.000Z",
  "data": {
    "rcsId": "clxx456...",
    "to": "5511999999999",
    "status": "CLICKED",
    "clickedAt": "2025-02-10T14:35:00.000Z"
  }
}

rcs.failed

Best practice: trigger fallback (SMS, email) when the number does not support RCS.

{
  "event": "rcs.failed",
  "workspaceId": "clxx123...",
  "instanceId": "inst_rcs_abc123",
  "timestamp": "2025-02-10T14:29:30.000Z",
  "data": {
    "rcsId": "clxx456...",
    "to": "5511999999999",
    "status": "FAILED",
    "failedAt": "2025-02-10T14:29:30.000Z",
    "errorMessage": "rcs_not_supported"
  }
}

rcs.cancelled

{
  "event": "rcs.cancelled",
  "workspaceId": "clxx123...",
  "instanceId": "",
  "timestamp": "2025-02-10T12:00:00.000Z",
  "data": {
    "rcsId": "clxx456...",
    "to": "5511999999999",
    "status": "CANCELLED"
  }
}

Next steps

Quick Start: first send
Introduction: status lifecycle
RCS instances: branded agents
Scopes: key permissions
Webhooks (general guide)

RCS API

Mensagens

Instâncias

Inbound

In short

POST shape

What your server should return

Event reference

Payload per event

Next steps

​In short

​POST shape

​What your server should return

​Event reference

​Payload per event

​Next steps

In short

POST shape

What your server should return

Event reference

Payload per event

Next steps