FAQ about App APIs

Prev Next

Is any integration needed for APIs?

SDK does not require any integration for the APIs. You can follow the steps in the API references. Your app developer should handle this development. Since the API developments do not require any SDK integrations, the application does not require an update from the Stores either.

Can Push API send push notifications to a specific segment?

No. Each user receiving the push notification should be described in the payload one by one. Thus, we can't send a push notification to a segment defined in the Insider Mobile Panel. Bulk Push API can be used to send a push notification to a specific segment.

What is the difference between the API key uploaded to the panel and the API key used in the Push API?

The API key uploaded to the panel is generated by Firebase and is used to send push notifications to Android devices. On the other hand, the Push API key, or Server API key, is generated by Insider and is used to send push notifications via API.

What does the "No Partner Found With API Key" error that appears while trying to send notifications via Push API mean?

This error message returns if the partner tries to send an API request using an invalid API key. 

What is the notification array in the payload?

The notifications array is the array that can contain multiple notification objects. These notification objects consist of a target, title, message, etc. You can add multiple notification objects into the notifications array and send multiple messages to multiple users.

How can we send test push notifications via Push API?

To send push notifications only to test devices, you would only need to include "test_push": true in the request body.

Can we insert badges on top of the application icon in the push notifications sent by Push API?

To show a badge on the application icon, you must implement the badge key value field in the payload (e.g., "badge":2).

What is Bulk Push API and what is the difference between Bulk Push API and Push API?

Bulk Push API is used to send push notifications to a specific segment. Please remember that the intended segment should first be created on the Insider Mobile Panel. As for the Push API, each user that is intended to receive the push notification should be implemented in the payload one by one.

Can we use batch deliveries for the push notifications sent by Bulk Push API?

Yes. If the batch delivery is selected in the Delivery Options, the push notification deliveries will be sent in batches.

What is Advanced Push API? What do we use it for?

Insider Advanced Push API is a service that programmatically sends push notifications in real time over the web using a predefined web service. Advanced Push API works specifically with web services that you create. You can use Advanced Push API in various scenarios such as sending recommended items based on your users' previous visits/purchases or informing users of a sale on items on their wish list.

Can I use Event API to share any data about users not registered in the Insider database?

No, that is not possible. A user must be registered in the Insider database to be updated by their events. This means the user should install the application and start a session at least once.

Can we host the image on our end and display it in the push notification by calling it via an API?

You can use the Targeted API for rich push notifications with one image, and Advanced API for carousel and slider push notifications.

How can I see user-specific campaign analytics?

You can see these analytics via mobile app analytics APIs.

Can I add images for API Push?

Yes, you can use images via Advanced Push API

Can we send an app push after the order status is updated (e.g. picked, shipped, delivered, etc.)?

Yes, you can run campaigns based on these rules using the Targeted API

Does Global Frequency Capping apply to pushes sent via Targeted API and Bulk Push API?

Yes, Global Frequency Capping applies to pushes sent through Targeted API and Bulk Push API. You can also bypass the Global Frequency Cap in these APIs.