Reporting API

This is the API used by our Android, iOS and Web SDKs to report back notification events.

We highly recommend that you use our official Android, iOS and Web SDKs. If your use case requires this documentation, please contact us betterbeams@pusher.com

∞ Reporting a notification acknowledgment

This event should be triggered when a device receives a notification.

POST https://<YOUR_INSTANCE_ID>.pushnotifications.pusher.com/reporting_api/v2/instances/<YOUR_INSTANCE_ID>/events

∞ Request headers

The following headers are necessary:

• Content-Type: with the value always set to application/json.

∞ Request body

A JSON object with the following keys:

∞ eventString Required

Must be set to delivery.

∞ publishIdString Required

The ID used to identify the publish request that led to this notification.

∞ deviceIdString Required

The ID used to identify the device.

∞ timestampSecsInt Required

The unix timestamp in seconds.

∞ userIdString Optional

The ID of the User that received this notification. This is required if using Authenticated Users and Webhooks.

∞ appInBackgroundBoolean Optional

Describes if the application was in background when a notification was delivered.

∞ hasDisplayableContentBoolean Optional

Describes if the notification had an UI element to the user.

∞ hasDataBoolean Optional

Describes if the notification contained an additional data payload.

∞ Response

If the event is well formed, the success response will be a 200 OK.

∞ Error Responses

∞ Reporting a notification open

This event should be triggered when a user taps on a notification.

POST https://<YOUR_INSTANCE_ID>.pushnotifications.pusher.com/reporting_api/v2/instances/<YOUR_INSTANCE_ID>/events

∞ Request headers

The following headers are necessary:

• Content-Type: with the value always set to application/json.

∞ Request body

A JSON object with the following keys:

∞ eventString Required

Must be set to open.

∞ publishIdString Required

The ID used to identify the publish request that led to this notification.

∞ deviceIdString Required

The ID used to identify the device.

∞ timestampSecsInt Required

The unix timestamp in seconds.

∞ userIdString Optional

The ID of the User that received this notification. This is required if using Authenticated Users and Webhooks.

∞ Response

If the event is well formed, the success response will be a 200 OK.

∞ Error Responses