Documentation / Product / Integrations / Localytics

Localytics: Triggered Push

Trigger push notifications through Localytics when users enter a Lytics audience.

Integration Details

  • Implementation Type: Server-side.
  • Implementation Technique: REST API.
  • Frequency: Real-time triggered.
  • Resulting Data: Custom mapping between Lytics user fields and Localytics push configuration.

This integration utilizes the Localytics Push API to send push notifications to Localytics users. As new users enter a Lytics audience who have a Localytics ID, a push notification will be triggered via Localytics.

Fields

By default, Lytics exports the following fields to Localytics. Other user fields can be sent using the templating explained below.

Lytics User FieldDescriptionLocalytics FieldType
localytics_customer_idLocalytics Customer ID FieldCustomer ID Fieldstring

Configuration

Follow these steps to set up and configure triggered push notifications job to Localytics in the Lytics platform. If you are new to creating jobs in Lytics, see the Jobs Dashboard documentation for more information.

  1. Select Localytics.
  2. Select the Export Triggered Push job type from the list.
  3. Select the Authorization you would like to use or create a new one.
  4. Select the audience to export.
  5. Complete the configuration steps for your job. Localytics triggered push config
  6. Select the Existing Users checkbox, to check this to immediately trigger pushes to users who currently exist in the selected Lytics audience.
  7. From the Localytics App input, select select the Localytics app to send messages from.
  8. From the Customer ID Field input, select field that contains the ID that uniquely identifies the Localytics customer.
  9. In the Alert input, enter the push notification text.
  10. From the Alert Title input, optional - enter a short string describing the purpose of the notification.
  11. From the Alert Subtitle input, optional - enter a short string that expands on the title. This is only displayed for users running iOS 10 (and above).
  12. Other Push Options - The rest of the options map directly to options available via the Push API in Localytics. See Localytics Push API documentation for more information.
  13. In the iOS Sound text box, enter optional - specifies the sound file in the app bundle or in the Library/Sounds folder of the app’s data container. If the sound file doesn’t exist or default is specified as the value, the default alert sound is played.
  14. In the iOS Category text box, enter optional - specifies the category of actions (interactive push) to display to the user upon delivery.
  15. %!(EXTRA string=iOS Badge) optional - specifies the unread badge number to display upon delivery.
  16. From the iOS Deep Link URL input, enter optional - specifies the url of the rich media attachment.
  17. From the iOS Attachment URL input, enter optional - specifies the url of the rich media attachment.
  18. From the iOS Attachment Type input, enter optional - specifies the media type of the rich media attachment.
  19. In the Android Priority text box, enter optional - specifies whether the notification should pre-emptively wake the device from Doze mode.
  20. In the Android Channel text box, enter optional - specifies the channel for the notification.
  21. From the Android Deep Link URL input, enter optional - specifies the deeplink url.
  22. From the Android Attachment URL input, enter optional - specifies the url of the rich media attachment.
  23. Click Start Export.

Templating

User profile fields can be dynamically inserted into an alert using templating of supported fields. The Localytics fields including the alert title, alert subtitle, and alert body fields. For template examples and details on how to find available user fields, see the Templating section.