← API Index


PushSend (v1)

One push notification send per delivery channel: what was sent, to whom, and how far it got (accepted / delivered / opened)

# Field Type Description
0 batch_id string id shared by all channel rows of the same push; also referenced by the sys_push shop event
1 type string what triggered the push: ADMIN, ORDER_REMINDER, ORDER_CHANGE, DELIVERY_CONFIRMATION, DEPOSIT_REFUND_ANNOUNCE, FORGOTTEN_CART, OTP, SERIES (sent from the message queue - a series or a single queued message)
2 channel string delivery channel: onesignal, fcm, or external (handed to the configured push hook)
3 target int customer id the push was addressed to, or 0 for a broadcast to all devices
4 title string notification title
5 recipients int number of devices targeted on this channel (for external: as reported by the provider, 0 if unreported)
6 accepted int number of devices the provider accepted the message for - not proof of delivery
7 delivered int delivery receipts reported back by the app (fcm/external only, requires app-side analytics)
8 opened int notification taps reported back by the app (fcm/external only, requires app-side analytics)
9 analytics_capable int how many of the targeted devices can report delivery/open at all; 0 means delivered/opened carry no information
10 state string pending, accepted, partial, failed, skipped, delivered, opened
11 error string error detail when state is failed/partial, empty otherwise
12 created datetime when the push was sent
13 serieref int message series this push belongs to (see stats/mailcampaigns1), 0 for an event push not sent from the queue

Used in endpoints

Referenced in skills