ComRaidComRaid Docs

Acknowledgements

Optional mobile acknowledgements for delivered, opened, and action-button click events.

Why acknowledgements?

Provider acceptance alone is Delivery status sent. It does not mean the Endpoint displayed or opened the Notification. App-side acknowledgements advance the Delivery to delivered and opened. Dashboard open rate is opened ÷ delivered.

When a Notification includes action buttons, a button tap should call the opened endpoint with action_id. That marks the Delivery opened and records the first click for that button (per-Delivery, first write wins).

React Native

With @comraid/react-native, call ComRaid.initialize with ConfigureOptions, then use acknowledgeDelivered / acknowledgeOpened (and flushAcks if needed). Remote display and durable ACK enqueue usually run inside the native FCM / APNs path; JS can also forward explicit ACKs. See React Native SDK.

import { ComRaid } from '@comraid/react-native';

await ComRaid.initialize({
  appId: 'cr_app_...',
  ios: { apnsEnvironment: 'sandbox' },
});

// After you extract cr_delivery_id / cr_attribution_token from the payload:
await ComRaid.acknowledgeDelivered(deliveryId, attributionToken);
await ComRaid.acknowledgeOpened(deliveryId, attributionToken, 'accept');
await ComRaid.flushAcks();

On Android, ComraidMessagingService presents the Notification and enqueues the delivered ACK from a background or cold process (config from on-device storage). On iOS, alert pushes always carry mutable-content; delivered from background or killed requires a Notification Service Extension. Force-stopped Android apps and Endpoints that treat swipe-away as force-stop still receive nothing from FCM.

Mark delivered

POST https://api.comraid.io/deliveries/{id}/delivered
Content-Type: application/json

{
  "attribution_token": "delivery-scoped-token-from-payload"
}

Custom clients POST here with the delivery-scoped attribution token from the payload (cr_delivery_id, cr_attribution_token).

Mark opened

POST https://api.comraid.io/deliveries/{id}/opened
Content-Type: application/json

{
  "attribution_token": "delivery-scoped-token-from-payload"
}

Body tap (no button): same route without action_id.

Mark opened with action button

POST https://api.comraid.io/deliveries/{id}/opened
Content-Type: application/json

{
  "attribution_token": "delivery-scoped-token-from-payload",
  "action_id": "accept"
}
  • action_id must match an id from content.push.actions on that Notification.
  • Sets opened_at (and delivered) like a normal open, and stores action_id / action_clicked_at on the Delivery once.
  • Retries do not change a recorded action id (first write wins). Message detail exposes status_summary.action_clicks rollups.
  • Do not send action_id on /delivered.

Behavior

  • Both endpoints are safe to retry — timestamps are set once. A repeat ack returns 200 with the stored Delivery status (not the requested one when they differ; delivered never downgrades opened).
  • Acks are accepted for 30 days after the Delivery's sent_at (or creation time when it was never sent). Later requests, and acks for a deleted Project, return 410.
  • An ack on a skipped or failed Delivery returns 409.
  • Unknown action_id on opened → 400. Bad or missing attribution token → 401.
  • Official SDKs drop 4xx responses from the durable ack queue (no endless retry on client errors).
  • Marking opened also marks delivered.
  • Send the Delivery-scoped attribution token from the payload (cr_delivery_id, cr_attribution_token) — do not ship your Project API key in the mobile binary.
  • On React Native, prefer ComRaid.acknowledgeDelivered / acknowledgeOpened so the native durable queue can flush retries across restarts.

Acknowledgements are telemetry about communication, not proof of purchase or conversion. Store product conversions in your own database using attribution IDs. Schemas: markDeliveryDelivered, markDeliveryOpened.

On this page