{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Quick Start Guide (Must read)","type":"basic","slug":"quick-start-guide-must-read","excerpt":"This page will help you get started with Pulsate Documentation.","body":"Welcome to Pulsate!\n\nThis quick start guide will give you a brief overview of how you can quickly get up and running with Pulsate. \n\nThere are two main components to Pulsate. The first is a web based CMS where you can setup customer segments, add geofences and beacons and start to build beautiful campaigns to engage your customers. If you are reading this, you have already successfully logged into Pulsate and found our documentation. Good job!\n\nThe other important component of Pulsate are our SDKs for Android and iOS that you can add to your existing mobile app so that we can start tracking and engaging your app users right away. \n\nYou have successfully logged into Pulsate and found our documentation so the next step is to add our SDK to your existing Android app. The basic integration of Pulsate can be done in these 4 steps:\n\n1. [Installing the Pulsate SDK](https://pulsate.readme.io/v2.8/docs/installing-the-android-pulsate-sdk)\n2. [Managing Pulsate Sessions](https://pulsate.readme.io/v2.8/docs/running-the-android-pulsate-sdk)\n3. [FCM Configuration - Push Notifications](https://pulsate.readme.io/v2.8/docs/fcm-configuration-1)\n4. [Location Permission - Geofences and Beacons](https://pulsate.readme.io/v2.8/docs/android-permissions)\n\nOnce you have successfully added the SDKs to your project, you will want to follow these detailed instructions: \n\nAndroid:\n- [Showing the Pulsate Inbox](https://pulsate.readme.io/v2.8/docs/configuring-the-pulsate-inbox)\n- [Passing User Data to Pulsate](https://pulsate.readme.io/v2.8/docs/passing-customer-names-and-email-addresses)\n-  [Passing Custom Attributes to Pulsate](https://pulsate.readme.io/v2.8/docs/passing-custom-parameters-to-pulsate)\n- [Passing Custom Events to Pulsate](https://pulsate.readme.io/v2.8/docs/creating-custom-events)\n- [Setting up Deeplinks to work with Pulsate](https://pulsate.readme.io/v2.8/docs/supporting-deeplinks)","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f3904903ec92d004873dc31","createdAt":"2020-08-16T10:04:00.717Z","user":"57bc3654b9c7f0220009c77b","category":{"sync":{"isSync":false,"url":""},"pages":["5e5019b49e8f240011cc6a52","5e5019b49e8f240011cc6a53","561988a188fdee0d00fb9c8b"],"title":"Start Here","slug":"start-here","order":0,"from_sync":false,"reference":false,"_id":"5e5019b49e8f240011cc6a47","version":"5e5019b49e8f240011cc6ade","__v":2,"createdAt":"2015-01-05T12:11:36.422Z","project":"54aa7f773b56130b0056c86e"},"version":{"version":"2.8","version_clean":"2.8.0","codename":"Android SDK","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e5019b49e8f240011cc6a47","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","5e5019b49e8f240011cc6a48","5e5019b49e8f240011cc6a49","5e5019b49e8f240011cc6a4a","5e5019b49e8f240011cc6a4b","5e5019b49e8f240011cc6a4c","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","5e5019b49e8f240011cc6a4d","5e5019b49e8f240011cc6a4e","5c73dd27e8fdc000572a206a","5e5019b49e8f240011cc6a4f","5e501b7e7c8bdc00450ea66a","5e53daa9884b750025b5cad4","5f2ab0dfbf70f7063ad0c4f3","5f2ab1e9448d87068b348f9c","5f2ab1f9c1644603559149ac","5f2ab205bc35e507e8cead35"],"_id":"5e5019b49e8f240011cc6ade","project":"54aa7f773b56130b0056c86e","forked_from":"5e4fbbbda8fb41028f1861fe","__v":6,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z"},"project":"54aa7f773b56130b0056c86e","__v":0,"parentDoc":null}

Quick Start Guide (Must read)

This page will help you get started with Pulsate Documentation.

Welcome to Pulsate! This quick start guide will give you a brief overview of how you can quickly get up and running with Pulsate. There are two main components to Pulsate. The first is a web based CMS where you can setup customer segments, add geofences and beacons and start to build beautiful campaigns to engage your customers. If you are reading this, you have already successfully logged into Pulsate and found our documentation. Good job! The other important component of Pulsate are our SDKs for Android and iOS that you can add to your existing mobile app so that we can start tracking and engaging your app users right away. You have successfully logged into Pulsate and found our documentation so the next step is to add our SDK to your existing Android app. The basic integration of Pulsate can be done in these 4 steps: 1. [Installing the Pulsate SDK](https://pulsate.readme.io/v2.8/docs/installing-the-android-pulsate-sdk) 2. [Managing Pulsate Sessions](https://pulsate.readme.io/v2.8/docs/running-the-android-pulsate-sdk) 3. [FCM Configuration - Push Notifications](https://pulsate.readme.io/v2.8/docs/fcm-configuration-1) 4. [Location Permission - Geofences and Beacons](https://pulsate.readme.io/v2.8/docs/android-permissions) Once you have successfully added the SDKs to your project, you will want to follow these detailed instructions: Android: - [Showing the Pulsate Inbox](https://pulsate.readme.io/v2.8/docs/configuring-the-pulsate-inbox) - [Passing User Data to Pulsate](https://pulsate.readme.io/v2.8/docs/passing-customer-names-and-email-addresses) - [Passing Custom Attributes to Pulsate](https://pulsate.readme.io/v2.8/docs/passing-custom-parameters-to-pulsate) - [Passing Custom Events to Pulsate](https://pulsate.readme.io/v2.8/docs/creating-custom-events) - [Setting up Deeplinks to work with Pulsate](https://pulsate.readme.io/v2.8/docs/supporting-deeplinks)