{"_id":"5b720760c44b7600034b79b1","githubsync":"","category":{"_id":"5b720760c44b7600034b79a8","__v":35,"pages":["5b720760c44b7600034b79b1","5b720760c44b7600034b79b3","5b720760c44b7600034b79b4","5b720760c44b7600034b79b5","55e682b7de6fef23009480dc","5b720760c44b7600034b79b6","5b720760c44b7600034b79b7","5b720760c44b7600034b79b8","5b720760c44b7600034b79b9","5b720760c44b7600034b79ba","5b720760c44b7600034b79bb","5b720760c44b7600034b79bc","5b720760c44b7600034b79bd","5b720760c44b7600034b79d1","5b720760c44b7600034b79d2","5b720760c44b7600034b79d3","5b720760c44b7600034b79d4","5b720760c44b7600034b79d5","5b720760c44b7600034b79d8","5b720760c44b7600034b79d9","5b720760c44b7600034b79db","561c6ca0be5fb20d00077754","5b720760c44b7600034b79e0","5b720760c44b7600034b79e1","5b720760c44b7600034b79e2","5b720760c44b7600034b79e3","5b720760c44b7600034b79e4","5b720760c44b7600034b79e5","5b720760c44b7600034b79e6","56cfa5386c5d7a13005eec0f","56e73d86555c030e00a52a73","56e7460c9000b120000ffe2e","56e8c19e99c6400e003820cf","56e8c53fc88bf80e00f8bed8","56f06ff4d386ce0e008e9b21"],"project":"55e67aaa9cc7c62b00c4a1ea","version":"5b720760c44b7600034b7a08","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-02T04:30:13.305Z","from_sync":false,"order":1,"slug":"install-in-your-app","title":"Install in your app"},"parentDoc":null,"user":"55d2bd8e2463351700f67dd7","__v":53,"project":"55e67aaa9cc7c62b00c4a1ea","version":{"_id":"5b720760c44b7600034b7a08","project":"55e67aaa9cc7c62b00c4a1ea","__v":0,"forked_from":"5b1f2cbdfd653400031d8d9f","createdAt":"2015-09-02T04:27:23.612Z","releaseDate":"2015-09-02T04:27:23.612Z","categories":["5b720760c44b7600034b79a7","5b720760c44b7600034b79a8","5b720760c44b7600034b79a9","5b720760c44b7600034b79aa","5b720760c44b7600034b79ab","561c61b4ad272c0d00a892df","586c014c0abf1d0f000d04d4","58991d2ad207df0f0002186b","5b720760c44b7600034b79ac","5b720760c44b7600034b79ad","5af0fe494ca2730003cbc98a","5af0fe55ec80af0003804ca2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"API V6","version_clean":"1.4.0","version":"1.4"},"updates":["59094a6595b5490f0052ea36","59e5fc0ffce6c0003a3615cb"],"next":{"pages":[],"description":""},"createdAt":"2015-09-02T04:31:13.245Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","apiSetting":null,"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Add the Sailthru Mobile SDK into your apps to enable tracking of live user data, user activity, and send push and in-app messages.  It typically takes less than 10 minutes to successfully integrate.\n\nPick a platform below for integration documentation:\n\n\n\n[block:html]\n{\n  \"html\": \"  <div class=\\\"row integrate-sdk-section\\\" >\\n    <div class=\\\"col-sm-4\\\">\\n      <a href=\\\"/docs/ios-integration\\\">\\n        <img src=\\\"https://files.readme.io/z5IuJfO8SzK9n94EcNQ5_ios.png\\\" >\\n      </a>\\n      <div class=\\\"description\\\" data-release-info=\\\"https://api.github.com/repos/carnivalmobile/carnival-ios-sdk/releases/latest\\\">\\n        <a href=\\\"/docs/ios-integration\\\">iOS</a><span class=\\\"version\\\"><a href=\\\"https://github.com/carnivalmobile/carnival-ios-sdk/releases\\\">v8.3.0</a></span>\\n        <div class=\\\"release-date\\\">Released 2019-06-24</div>\\n      </div>\\n    </div>\\n\\n\\n    <div class=\\\"col-sm-4\\\">\\n      <a href=\\\"/docs/android-integration\\\">\\n      <img src=\\\"https://files.readme.io/QbxKWCzRs6nnEELD9FvQ_android.png\\\" >\\n      </a>\\n      <div class=\\\"description\\\" data-release-info=\\\"https://api.github.com/repos/carnivalmobile/carnival-ios-sdk/releases/latest\\\">\\n        <a href=\\\"/docs/android-integration\\\">Android</a><span class=\\\"version\\\"><a href=\\\"https://github.com/carnivalmobile/carnival-android-sdk/releases\\\">v8.1.0</a></span>\\n        <div class=\\\"release-date\\\">Released 2019-06-27</div>\\n      </div>\\n    </div>\\n    \\n    <div class=\\\"col-sm-4\\\">\\n      <a href=\\\"/docs/react-native-integration\\\">\\n      <img src=\\\"https://files.readme.io/HMUOEq2uTAiGoCSpCjCN_react-native.png\\\" >\\n      </a>\\n      <div class=\\\"description\\\" data-release-info=\\\"https://api.github.com/repos/carnivalmobile/carnival-sdk-react-native/releases/latest\\\">\\n        <a href=\\\"/docs/react-native-integration\\\">React Native</a><span class=\\\"version\\\"><a href=\\\"https://github.com/carnivalmobile/carnival-sdk-react-native/releases\\\">v3.1.0</a></span>\\n        <div class=\\\"release-date\\\">Released 2019-07-05</div>\\n      </div>\\n    </div>\\n    \\n  </div>\\n\\n  <div class=\\\"row integrate-sdk-section\\\" style=\\\"display:none\\\">\\n    <div class=\\\"col-sm-4\\\" >\\n      <a href=\\\"/docs/cordova-integration\\\">\\n      <img src=\\\"https://files.readme.io/6IZ4WpXnQlWtll7zn55W_cordova.png\\\" >\\n      </a>\\n      <div class=\\\"description\\\" data-release-info=\\\"https://api.github.com/repos/carnivalmobile/carnival-sdk-cordova/releases/latest\\\">\\n        <a href=\\\"/docs/cordova-integration\\\">Cordova</a><span class=\\\"version\\\"><a href=\\\"https://github.com/carnivalmobile/carnival-sdk-cordova/releases\\\">v4.0.3</a></span>\\n        <div class=\\\"release-date\\\">Released 2017-12-06</div>\\n      </div>\\n    </div>\\n  \\n    <div class=\\\"col-sm-4\\\" >\\n      <a href=\\\"/docs/unity-integration\\\">\\n     <img src=\\\"https://files.readme.io/FY6VQd92SjGp5cb6OEC9_unity.png\\\">\\n      </a>\\n      <div class=\\\"description\\\" data-release-info=\\\"https://api.github.com/repos/carnivalmobile/carnival-sdk-unity/releases/latest\\\">\\n        <a href=\\\"/docs/unity-integration\\\">Unity</a><span class=\\\"version\\\"><a href=\\\"https://github.com/carnivalmobile/carnival-sdk-unity/releases\\\">v1.0.0</a></span>\\n        <div class=\\\"release-date\\\">Released 2017-12-06</div>\\n      </div>\\n    </div>\\n\\n  </div>\\n\\n  <style>\\n    \\n    .integrate-sdk-section img{\\n      width:120px;\\n      height:120px;\\n      display: block;\\n      margin: auto;\\n    }\\n    \\n    .integrate-sdk-section a {\\n      display:block;\\n      padding:20px 0px 10px 0px;\\n      border-radius:5px;\\n    }\\n    \\n    .integrate-sdk-section a:hover {\\n      background-color:#f9f9f9 !important;\\n    \\n    }\\n    \\n    .integrate-sdk-section .col-sm-3 {\\n      text-align:center;\\n    }\\n    \\n    .integrate-sdk-section .description {\\n      padding-top:10px;\\n      text-align:center !important;\\n    }\\n      \\n    \\n    .integrate-sdk-section .description > a {\\n      padding-top:0;\\n      display:inline;\\n    }\\n\\n    .integrate-sdk-section .description span.version {\\n      font-size:1.1rem;\\n      margin-left:10px;\\n    }\\n    \\n    .integrate-sdk-section .description span.version > a {\\n      display:inline;\\n      margin:0;\\n      padding:0;\\n    }\\n\\n    .integrate-sdk-section .description div.release-date {\\n      font-size:1.1rem;\\n    }\\n    \\n  </style>\"\n}\n[/block]\n## Migrating from another platform\n\nWe can help you migrate existing push tokens and data from your current provider. Please read [Migrating to Sailthru Mobile](doc:migrating-to-carnival) guide for more details.\n\n## Message Stream Templates\nOur [Message Stream Templates](https://github.com/carnivalmobile/carnival-stream-examples) are available for Native iOS and Android apps only.\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Plugin SDKs limitations\",\n  \"body\": \"Our SDKs for Unity and React Native experience don't allow to customize the look and feel of in-app notifications. This is due to the nature of their plugin system architecture. We hope to bring customization to these platforms in the near future.\\n\\nBecause of the nature of Cordova, Unity, React Native and their (many!) variants, some integrations may take longer. We're of course happy to help during this time. Reach out to [support](mailto:support:::at:::sailthru.com) for assistance.\"\n}\n[/block]\n## Deprecation and Support Policy\n\nOur Deprecation and Support Policy is detailed in the [SDK Deprecation And Support Guide](doc:sdk-deprecation-guide).\n\n\n## Supported Versions\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"SDK\",\n    \"h-1\": \"iOS\",\n    \"h-2\": \"Android\",\n    \"h-3\": \"React Native\",\n    \"h-4\": \"React Native\",\n    \"h-5\": \"Unity\",\n    \"0-0\": \"**Type**\",\n    \"1-0\": \"**Supported OS Versions**\",\n    \"2-0\": \"**Supported Tooling Versions**\",\n    \"0-1\": \"Core\",\n    \"0-2\": \"Core\",\n    \"0-3\": \"Wrapper\",\n    \"0-4\": \"Wrapper\",\n    \"0-5\": \"Wrapper\",\n    \"1-1\": \"iOS 8.0+\",\n    \"1-2\": \"Android Jelly Bean 4.1+ (API Level 16)\",\n    \"1-3\": \"Same as Core\",\n    \"1-4\": \"Same as Core\",\n    \"1-5\": \"Same as Core\",\n    \"2-1\": \"Xcode 8+\",\n    \"2-2\": \"Android Studio 3+\",\n    \"2-3\": \"React Native 0.48+\",\n    \"2-4\": \"React Native 0.48+\",\n    \"2-5\": \"Unity 5+ (2017.2.x)\",\n    \"3-0\": \"**Supported SDK Versions**\",\n    \"3-1\": \"8.0.0+\",\n    \"3-2\": \"5.0.0+\",\n    \"3-3\": \"2.3.0+\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]","excerpt":"","slug":"sdk-integration","type":"basic","title":"Add the SDK"}
Add the Sailthru Mobile SDK into your apps to enable tracking of live user data, user activity, and send push and in-app messages. It typically takes less than 10 minutes to successfully integrate. Pick a platform below for integration documentation: [block:html] { "html": " <div class=\"row integrate-sdk-section\" >\n <div class=\"col-sm-4\">\n <a href=\"/docs/ios-integration\">\n <img src=\"https://files.readme.io/z5IuJfO8SzK9n94EcNQ5_ios.png\" >\n </a>\n <div class=\"description\" data-release-info=\"https://api.github.com/repos/carnivalmobile/carnival-ios-sdk/releases/latest\">\n <a href=\"/docs/ios-integration\">iOS</a><span class=\"version\"><a href=\"https://github.com/carnivalmobile/carnival-ios-sdk/releases\">v8.3.0</a></span>\n <div class=\"release-date\">Released 2019-06-24</div>\n </div>\n </div>\n\n\n <div class=\"col-sm-4\">\n <a href=\"/docs/android-integration\">\n <img src=\"https://files.readme.io/QbxKWCzRs6nnEELD9FvQ_android.png\" >\n </a>\n <div class=\"description\" data-release-info=\"https://api.github.com/repos/carnivalmobile/carnival-ios-sdk/releases/latest\">\n <a href=\"/docs/android-integration\">Android</a><span class=\"version\"><a href=\"https://github.com/carnivalmobile/carnival-android-sdk/releases\">v8.1.0</a></span>\n <div class=\"release-date\">Released 2019-06-27</div>\n </div>\n </div>\n \n <div class=\"col-sm-4\">\n <a href=\"/docs/react-native-integration\">\n <img src=\"https://files.readme.io/HMUOEq2uTAiGoCSpCjCN_react-native.png\" >\n </a>\n <div class=\"description\" data-release-info=\"https://api.github.com/repos/carnivalmobile/carnival-sdk-react-native/releases/latest\">\n <a href=\"/docs/react-native-integration\">React Native</a><span class=\"version\"><a href=\"https://github.com/carnivalmobile/carnival-sdk-react-native/releases\">v3.1.0</a></span>\n <div class=\"release-date\">Released 2019-07-05</div>\n </div>\n </div>\n \n </div>\n\n <div class=\"row integrate-sdk-section\" style=\"display:none\">\n <div class=\"col-sm-4\" >\n <a href=\"/docs/cordova-integration\">\n <img src=\"https://files.readme.io/6IZ4WpXnQlWtll7zn55W_cordova.png\" >\n </a>\n <div class=\"description\" data-release-info=\"https://api.github.com/repos/carnivalmobile/carnival-sdk-cordova/releases/latest\">\n <a href=\"/docs/cordova-integration\">Cordova</a><span class=\"version\"><a href=\"https://github.com/carnivalmobile/carnival-sdk-cordova/releases\">v4.0.3</a></span>\n <div class=\"release-date\">Released 2017-12-06</div>\n </div>\n </div>\n \n <div class=\"col-sm-4\" >\n <a href=\"/docs/unity-integration\">\n <img src=\"https://files.readme.io/FY6VQd92SjGp5cb6OEC9_unity.png\">\n </a>\n <div class=\"description\" data-release-info=\"https://api.github.com/repos/carnivalmobile/carnival-sdk-unity/releases/latest\">\n <a href=\"/docs/unity-integration\">Unity</a><span class=\"version\"><a href=\"https://github.com/carnivalmobile/carnival-sdk-unity/releases\">v1.0.0</a></span>\n <div class=\"release-date\">Released 2017-12-06</div>\n </div>\n </div>\n\n </div>\n\n <style>\n \n .integrate-sdk-section img{\n width:120px;\n height:120px;\n display: block;\n margin: auto;\n }\n \n .integrate-sdk-section a {\n display:block;\n padding:20px 0px 10px 0px;\n border-radius:5px;\n }\n \n .integrate-sdk-section a:hover {\n background-color:#f9f9f9 !important;\n \n }\n \n .integrate-sdk-section .col-sm-3 {\n text-align:center;\n }\n \n .integrate-sdk-section .description {\n padding-top:10px;\n text-align:center !important;\n }\n \n \n .integrate-sdk-section .description > a {\n padding-top:0;\n display:inline;\n }\n\n .integrate-sdk-section .description span.version {\n font-size:1.1rem;\n margin-left:10px;\n }\n \n .integrate-sdk-section .description span.version > a {\n display:inline;\n margin:0;\n padding:0;\n }\n\n .integrate-sdk-section .description div.release-date {\n font-size:1.1rem;\n }\n \n </style>" } [/block] ## Migrating from another platform We can help you migrate existing push tokens and data from your current provider. Please read [Migrating to Sailthru Mobile](doc:migrating-to-carnival) guide for more details. ## Message Stream Templates Our [Message Stream Templates](https://github.com/carnivalmobile/carnival-stream-examples) are available for Native iOS and Android apps only. [block:callout] { "type": "warning", "title": "Plugin SDKs limitations", "body": "Our SDKs for Unity and React Native experience don't allow to customize the look and feel of in-app notifications. This is due to the nature of their plugin system architecture. We hope to bring customization to these platforms in the near future.\n\nBecause of the nature of Cordova, Unity, React Native and their (many!) variants, some integrations may take longer. We're of course happy to help during this time. Reach out to [support](mailto:support@sailthru.com) for assistance." } [/block] ## Deprecation and Support Policy Our Deprecation and Support Policy is detailed in the [SDK Deprecation And Support Guide](doc:sdk-deprecation-guide). ## Supported Versions [block:parameters] { "data": { "h-0": "SDK", "h-1": "iOS", "h-2": "Android", "h-3": "React Native", "h-4": "React Native", "h-5": "Unity", "0-0": "**Type**", "1-0": "**Supported OS Versions**", "2-0": "**Supported Tooling Versions**", "0-1": "Core", "0-2": "Core", "0-3": "Wrapper", "0-4": "Wrapper", "0-5": "Wrapper", "1-1": "iOS 8.0+", "1-2": "Android Jelly Bean 4.1+ (API Level 16)", "1-3": "Same as Core", "1-4": "Same as Core", "1-5": "Same as Core", "2-1": "Xcode 8+", "2-2": "Android Studio 3+", "2-3": "React Native 0.48+", "2-4": "React Native 0.48+", "2-5": "Unity 5+ (2017.2.x)", "3-0": "**Supported SDK Versions**", "3-1": "8.0.0+", "3-2": "5.0.0+", "3-3": "2.3.0+" }, "cols": 4, "rows": 4 } [/block]