Webhook Events - Notifique

With the API you ask; with webhooks Notifique tells you. Great for tracking delivery, measuring clicks, or removing devices with invalid subscriptions, without polling.

In brief

Every delivery is a POST application/json to your registered URL.
push.* events are push only, WhatsApp uses message.*, SMS uses sms.*.
instanceId is empty (push does not use a channel instance).
Enable only the events your integration needs.
Respond 2xx quickly; heavy processing goes to your queue.

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

How the POST looks

{
  "event": "push.delivered",
  "workspaceId": "clxx123...",
  "instanceId": "",
  "timestamp": "2025-02-10T14:30:00.000Z",
  "data": {
    "pushId": "clxx456...",
    "deviceId": "clxx789...",
    "appId": "clxxabc...",
    "status": "DELIVERED",
    "deliveredAt": "2025-02-10T14:30:05.000Z"
  }
}

Field	Description
`event`	Event name (e.g. `push.delivered`)
`workspaceId`	Workspace ID
`instanceId`	Always empty for push
`timestamp`	ISO 8601, use for anti-replay
`data`	Send fields (`pushId`, `deviceId`, `appId`, `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 the background.

Event reference

Event	When it fires	What to do with it
`push.sent`	Push accepted and sent to provider	Mark as sent
`push.delivered`	Device confirmed delivery	Delivery metrics
`push.clicked`	User opened the notification	Deep link, conversion
`push.failed`	Invalid subscription or error	Remove or update device
`push.cancelled`	Schedule cancelled before send	Update queue

Payload per event

push.sent

{
  "event": "push.sent",
  "workspaceId": "clxx123...",
  "instanceId": "",
  "timestamp": "2025-02-10T14:29:00.000Z",
  "data": {
    "pushId": "clxx456...",
    "deviceId": "clxx789...",
    "appId": "clxxabc...",
    "status": "SENT",
    "title": "Hello!",
    "sentAt": "2025-02-10T14:29:00.000Z"
  }
}

push.delivered

Fires when the service worker or client reports delivery.

{
  "event": "push.delivered",
  "workspaceId": "clxx123...",
  "instanceId": "",
  "timestamp": "2025-02-10T14:30:00.000Z",
  "data": {
    "pushId": "clxx456...",
    "deviceId": "clxx789...",
    "appId": "clxxabc...",
    "status": "DELIVERED",
    "deliveredAt": "2025-02-10T14:30:05.000Z"
  }
}

push.clicked

{
  "event": "push.clicked",
  "workspaceId": "clxx123...",
  "instanceId": "",
  "timestamp": "2025-02-10T14:35:00.000Z",
  "data": {
    "pushId": "clxx456...",
    "deviceId": "clxx789...",
    "appId": "clxxabc...",
    "status": "CLICKED",
    "clickedAt": "2025-02-10T14:35:00.000Z",
    "url": "https://yoursite.com/notifications"
  }
}

push.failed

Best practice: deactivate or remove the deviceId on invalid subscription.

{
  "event": "push.failed",
  "workspaceId": "clxx123...",
  "instanceId": "",
  "timestamp": "2025-02-10T14:29:30.000Z",
  "data": {
    "pushId": "clxx456...",
    "deviceId": "clxx789...",
    "appId": "clxxabc...",
    "status": "FAILED",
    "failedAt": "2025-02-10T14:29:30.000Z",
    "errorMessage": "subscription_expired"
  }
}

push.cancelled

{
  "event": "push.cancelled",
  "workspaceId": "clxx123...",
  "instanceId": "",
  "timestamp": "2025-02-10T12:00:00.000Z",
  "data": {
    "pushId": "clxx456...",
    "deviceId": "clxx789...",
    "appId": "clxxabc...",
    "status": "CANCELLED"
  }
}

Next steps

Quick Start: app → device → send
Introduction: status lifecycle
Scopes: key permissions
Webhooks (general guide)

​In brief

​How the POST looks

​What your server should return

​Event reference

​Payload per event

​Next steps

In brief

How the POST looks

What your server should return

Event reference

Payload per event

Next steps