Is there any need to integrate APIs?
There is no integration on the SDK side. It is sufficient to follow the steps in the API documentation. This development is the customer's responsibility. Since the API developments don't need SDK integration, the application doesn't require an update from the stores.
How does the Targeted Push API work, and what is its purpose?
Targeted Push API allows you to programmatically send push notifications to specific users in real time by making HTTP requests to Insider’s API endpoint. It’s designed to integrate seamlessly with your own systems and workflows.
You can use the Targeted Push API for scenarios such as sending personalized order updates from your e-commerce platform, notifying users about a sale on a wishlist item, or delivering any real-time, user-specific message.
The API accepts user identifiers (such as device tokens, email addresses, or custom IDs), message content, and optional parameters, including deep links and custom attributes, enabling you to send highly targeted and personalized push notifications directly from your backend systems.
Can Targeted Push API send pushes to a specific segment?
No. With the Targeted Push API, you must explicitly specify each user who should receive the push in the API payload using unique identifiers such as device tokens, email addresses, or custom IDs. Therefore, it’s not possible to directly send a push notification to a segment created in the panel using this API.
If you want to send a push to a predefined segment in the panel, use the Bulk Push API, which supports sending messages to user segments without listing individual users in the API request.
What is the Mobile App API Key, and the API Key asked in the API payload?
The Mobile App API Key is the key you generate in the Insider panel via Settings > Mobile App Settings > Integrations > API Keys.
This is the same API key that needs to be included in the payload when sending requests via the Targeted Push API. It authenticates your requests and ensures that push notifications are sent to the correct mobile app project associated with your Insider One account.
What is the reason for the error “api_key’ is either empty or wrong. You can get your API key from Insider Dashboard” while trying to send notifications via Targeted Push API?
This error message is returned if the customer tries to send an API request using an invalid API Key. The correct API Key should be provided to the customer to resolve the issue.
What is the Notification Array in the Payload?
Notifications array is the array that can contain multiple notification objects. These notification objects consist of target, title, message, etc. You can add multiple notification objects to the Notifications Array and send different messages to different users.
Can we insert badges on top of the application icon in the notifications sent by the Targeted Push API?
Yes, but only for iOS. To display a badge on the application icon, include the badge key in the API payload.
For example: "badge": 2. This will set the badge count on the app icon to 2.
Where can the results of the notifications sent by Targeted Push API be found?
The results of notifications sent by the Targeted Push API are available in the Push API Campaigns section of the Insider panel. You can check performance metrics directly there.
Which values can be found in the Targeted Push API Campaigns regarding the results of the Push API notification?
In the Push API Analytics section of the panel, you can view details such as the date and time it was created, the number of notifications delivered, and the number of opens, provided the camp_id field was included in the API payload. Additionally, you can view metrics such as the open rate, helping you analyze the performance of your notifications sent via the Targeted Push API.
What is Bulk Push API, and what is the difference between Bulk Push API and Targeted Push API?
The Bulk Push API is used to send push notifications to a specific segment. Remember that the intended segment should be created on the panel first. On the other hand, regarding Targeted Push API, each user who is intended to receive the push should be implemented one by one in the payload.
Can we use batch deliveries for the pushes sent by Bulk Push API?
Yes. If batch delivery is selected in Delivery Options, push deliveries will be sent in batches.
Where can the results of the notifications sent by Bulk Push API be found?
You can see the campaigns delivered by the Bulk Push API in the campaigns page on the panel. Thus, you can view the report in the campaign's results section.
What is Advanced Push API, and what is its purpose?
Advanced Push API is an extension of the Targeted Push API that allows you to send more sophisticated and visually rich push notifications directly via API requests. While the Targeted Push API is used to send standard push messages to specific users, the Advanced Push API builds on this by supporting advanced formats like carousels and sliders.
Advanced Push API supports rich formats like carousel and slider pushes, allowing you to send multiple items in a single notification, each with its own title, description, image, and deep link.