> For the complete documentation index, see [llms.txt](https://doc.batch.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.batch.com/developer/sdk.md).

# sdk

- [iOS](https://doc.batch.com/developer/sdk/ios.md)
- [Prerequisites](https://doc.batch.com/developer/sdk/ios/prerequisites.md)
- [SDK Integration](https://doc.batch.com/developer/sdk/ios/sdk-integration.md)
- [Initial setup](https://doc.batch.com/developer/sdk/ios/sdk-integration/initial-setup.md)
- [Push setup](https://doc.batch.com/developer/sdk/ios/sdk-integration/push-setup.md)
- [Rich notifications setup](https://doc.batch.com/developer/sdk/ios/sdk-integration/rich-notifications-setup.md)
- [Mobile landings](https://doc.batch.com/developer/sdk/ios/mobile-landings.md)
- [In-App Messaging](https://doc.batch.com/developer/sdk/ios/in-app-messaging.md)
- [Inbox](https://doc.batch.com/developer/sdk/ios/inbox.md)
- [Profile Data](https://doc.batch.com/developer/sdk/ios/profile-data.md)
- [Attributes](https://doc.batch.com/developer/sdk/ios/profile-data/attributes.md)
- [Events](https://doc.batch.com/developer/sdk/ios/profile-data/events.md)
- [Custom user ID](https://doc.batch.com/developer/sdk/ios/profile-data/custom-user-id.md)
- [Custom region/language](https://doc.batch.com/developer/sdk/ios/profile-data/custom-locale.md)
- [Email subscription](https://doc.batch.com/developer/sdk/ios/profile-data/email-subscription.md)
- [SMS subscription](https://doc.batch.com/developer/sdk/ios/profile-data/sms-subscription.md)
- [Topic preferences](https://doc.batch.com/developer/sdk/ios/profile-data/topic-preferences.md)
- [Profile data migration](https://doc.batch.com/developer/sdk/ios/profile-data/data-migration.md)
- [Testing your integration](https://doc.batch.com/developer/sdk/ios/profile-data/debug.md)
- [Data Privacy](https://doc.batch.com/developer/sdk/ios/data-privacy.md)
- [SDK opt-out (e.g. GDPR)](https://doc.batch.com/developer/sdk/ios/data-privacy/opt-out.md)
- [Automatic data collection](https://doc.batch.com/developer/sdk/ios/data-privacy/data-collection.md)
- [Event dispatchers](https://doc.batch.com/developer/sdk/ios/event-dispatchers.md)
- [Firebase](https://doc.batch.com/developer/sdk/ios/event-dispatchers/firebase.md)
- [Piano Analytics](https://doc.batch.com/developer/sdk/ios/event-dispatchers/piano-analytics.md)
- [AT Internet](https://doc.batch.com/developer/sdk/ios/event-dispatchers/at-internet.md)
- [Mixpanel](https://doc.batch.com/developer/sdk/ios/event-dispatchers/mixpanel.md)
- [Custom](https://doc.batch.com/developer/sdk/ios/event-dispatchers/custom.md)
- [Troubleshooting](https://doc.batch.com/developer/sdk/ios/troubleshooting.md)
- [Advanced](https://doc.batch.com/developer/sdk/ios/advanced.md)
- [General](https://doc.batch.com/developer/sdk/ios/advanced/general.md)
- [Customizing notifications](https://doc.batch.com/developer/sdk/ios/advanced/customizing-notifications.md)
- [Intercepting notifications](https://doc.batch.com/developer/sdk/ios/advanced/intercepting-notifications.md)
- [Deeplinking](https://doc.batch.com/developer/sdk/ios/advanced/deeplinking.md)
- [Custom actions](https://doc.batch.com/developer/sdk/ios/advanced/custom-actions.md)
- [Adding notification actions](https://doc.batch.com/developer/sdk/ios/advanced/adding-notification-actions.md)
- [App Groups](https://doc.batch.com/developer/sdk/ios/advanced/app-groups.md)
- [Manual integration](https://doc.batch.com/developer/sdk/ios/advanced/manual-integration.md)
- [Migration Guides](https://doc.batch.com/developer/sdk/ios/advanced/migration-guides.md)
- [Batch 1.16](https://doc.batch.com/developer/sdk/ios/advanced/migration-guides/1_16-migration.md)
- [Batch 2.0](https://doc.batch.com/developer/sdk/ios/advanced/migration-guides/2x-migration.md)
- [Batch 3.0](https://doc.batch.com/developer/sdk/ios/advanced/migration-guides/3x-migration.md)
- [SDK changelog](https://doc.batch.com/developer/sdk/ios/sdk-changelog.md)
- [Android](https://doc.batch.com/developer/sdk/android.md)
- [Prerequisites](https://doc.batch.com/developer/sdk/android/prerequisites.md)
- [SDK integration](https://doc.batch.com/developer/sdk/android/sdk-integration.md)
- [Mobile landings](https://doc.batch.com/developer/sdk/android/mobile-landings.md)
- [In-App Messaging](https://doc.batch.com/developer/sdk/android/in-app-messaging.md)
- [Inbox](https://doc.batch.com/developer/sdk/android/inbox.md)
- [Profile Data](https://doc.batch.com/developer/sdk/android/profile-data.md)
- [Attributes](https://doc.batch.com/developer/sdk/android/profile-data/attributes.md)
- [Events](https://doc.batch.com/developer/sdk/android/profile-data/events.md)
- [Custom user ID](https://doc.batch.com/developer/sdk/android/profile-data/custom-user-id.md)
- [Custom region/language](https://doc.batch.com/developer/sdk/android/profile-data/custom-locale.md)
- [Email subscription](https://doc.batch.com/developer/sdk/android/profile-data/email-subscription.md)
- [SMS subscription](https://doc.batch.com/developer/sdk/android/profile-data/sms-subscription.md)
- [Topic preferences](https://doc.batch.com/developer/sdk/android/profile-data/topic-preferences.md)
- [Profile data migration](https://doc.batch.com/developer/sdk/android/profile-data/data-migration.md)
- [Testing your integration](https://doc.batch.com/developer/sdk/android/profile-data/debug.md)
- [Data Privacy](https://doc.batch.com/developer/sdk/android/data-privacy.md)
- [SDK opt-out (e.g. GDPR)](https://doc.batch.com/developer/sdk/android/data-privacy/opt-out.md)
- [Automatic data collection](https://doc.batch.com/developer/sdk/android/data-privacy/data-collection.md)
- [Event dispatchers](https://doc.batch.com/developer/sdk/android/event-dispatchers.md)
- [Firebase](https://doc.batch.com/developer/sdk/android/event-dispatchers/firebase.md)
- [Piano Analytics](https://doc.batch.com/developer/sdk/android/event-dispatchers/piano-analytics.md)
- [AT Internet](https://doc.batch.com/developer/sdk/android/event-dispatchers/at-internet.md)
- [Mixpanel](https://doc.batch.com/developer/sdk/android/event-dispatchers/mixpanel.md)
- [Custom](https://doc.batch.com/developer/sdk/android/event-dispatchers/custom.md)
- [Troubleshooting](https://doc.batch.com/developer/sdk/android/troubleshooting.md)
- [Advanced](https://doc.batch.com/developer/sdk/android/advanced.md)
- [Customizing notifications](https://doc.batch.com/developer/sdk/android/advanced/customizing-notifications.md)
- [Notification channels](https://doc.batch.com/developer/sdk/android/advanced/notification-channels.md)
- [Custom actions](https://doc.batch.com/developer/sdk/android/advanced/custom-actions.md)
- [Getting the registration identifier](https://doc.batch.com/developer/sdk/android/advanced/getting-registration.md)
- [Migrating to FCM](https://doc.batch.com/developer/sdk/android/advanced/fcm-migration.md)
- [Overriding the FCM Sender ID](https://doc.batch.com/developer/sdk/android/advanced/fcm-sender-id-override.md)
- [Deeplinking](https://doc.batch.com/developer/sdk/android/advanced/deeplinking.md)
- [Low-level notification handling (deprecated)](https://doc.batch.com/developer/sdk/android/advanced/low-level-notification-handling.md)
- [Migrating from v1](https://doc.batch.com/developer/sdk/android/advanced/2x-migration.md)
- [Migrating from v2](https://doc.batch.com/developer/sdk/android/advanced/3x-migration.md)
- [SDK changelog](https://doc.batch.com/developer/sdk/android/sdk-changelog.md)
- [Web](https://doc.batch.com/developer/sdk/web.md)
- [Getting Started](https://doc.batch.com/developer/sdk/web/getting-started.md)
- [Prerequisites](https://doc.batch.com/developer/sdk/web/getting-started/prerequisites.md)
- [Integrating Batch Service Worker](https://doc.batch.com/developer/sdk/web/getting-started/batch-service-worker.md)
- [Adding the JavaScript snippet to your page](https://doc.batch.com/developer/sdk/web/getting-started/javascript-snippet.md)
- [Advanced](https://doc.batch.com/developer/sdk/web/advanced.md)
- [Registering a custom Service Worker](https://doc.batch.com/developer/sdk/web/advanced/declare-path-service-worker.md)
- [Integrating Batch with an existing Service Worker](https://doc.batch.com/developer/sdk/web/advanced/integrating-batch-with-existing-service-worker.md)
- [Domains and subdomains management](https://doc.batch.com/developer/sdk/web/advanced/manage-domains.md)
- [Managing icons in the Javascript tag](https://doc.batch.com/developer/sdk/web/advanced/tag-icons-management.md)
- [Migrating from v2](https://doc.batch.com/developer/sdk/web/advanced/2x-migration.md)
- [Migrating from v3](https://doc.batch.com/developer/sdk/web/advanced/3x-migration.md)
- [Migrating from V4](https://doc.batch.com/developer/sdk/web/advanced/4x-migration.md)
- [UI Components](https://doc.batch.com/developer/sdk/web/ui-components.md)
- [Profile Data](https://doc.batch.com/developer/sdk/web/profile-data.md)
- [Attributes](https://doc.batch.com/developer/sdk/web/profile-data/attributes.md)
- [Events](https://doc.batch.com/developer/sdk/web/profile-data/events.md)
- [Custom user ID](https://doc.batch.com/developer/sdk/web/profile-data/custom-user-id.md)
- [Custom region/language](https://doc.batch.com/developer/sdk/web/profile-data/custom-locale.md)
- [Email subscription](https://doc.batch.com/developer/sdk/web/profile-data/email-subscription.md)
- [Topic preferences](https://doc.batch.com/developer/sdk/web/profile-data/topic-preferences.md)
- [Testing your integration](https://doc.batch.com/developer/sdk/web/profile-data/debug.md)
- [Listening to SDK events](https://doc.batch.com/developer/sdk/web/listening-to-sdk-events.md)
- [Testing your integration](https://doc.batch.com/developer/sdk/web/testing-integration.md)
- [SDK changelog](https://doc.batch.com/developer/sdk/web/sdk-changelog.md)
- [Legacy Documentation](https://doc.batch.com/developer/sdk/web/legacy-documentation.md)
- [Custom user ID (V3)](https://doc.batch.com/developer/sdk/web/legacy-documentation/customid-v3.md)
- [Attributes (V3)](https://doc.batch.com/developer/sdk/web/legacy-documentation/custom-attributes-v3.md)
- [Events (V3)](https://doc.batch.com/developer/sdk/web/legacy-documentation/custom-events-v3.md)
- [Choosing the HTTP/Multidomain mode](https://doc.batch.com/developer/sdk/web/legacy-documentation/unsecure-mode.md)
- [Safari APNs setup](https://doc.batch.com/developer/sdk/web/legacy-documentation/safari-setup.md)
- [Flutter](https://doc.batch.com/developer/sdk/flutter.md)
- [Prerequisites](https://doc.batch.com/developer/sdk/flutter/prerequisites.md)
- [SDK integration](https://doc.batch.com/developer/sdk/flutter/sdk-integration.md)
- [Messaging (In-App/Landings)](https://doc.batch.com/developer/sdk/flutter/messaging.md)
- [Inbox](https://doc.batch.com/developer/sdk/flutter/inbox.md)
- [Profile Data](https://doc.batch.com/developer/sdk/flutter/profile-data.md)
- [Attributes](https://doc.batch.com/developer/sdk/flutter/profile-data/attributes.md)
- [Events](https://doc.batch.com/developer/sdk/flutter/profile-data/events.md)
- [Custom user ID](https://doc.batch.com/developer/sdk/flutter/profile-data/custom-user-id.md)
- [Custom region/language](https://doc.batch.com/developer/sdk/flutter/profile-data/custom-locale.md)
- [Email subscription](https://doc.batch.com/developer/sdk/flutter/profile-data/email-subscription.md)
- [SMS subscription](https://doc.batch.com/developer/sdk/flutter/profile-data/sms-subscription.md)
- [Topic preferences](https://doc.batch.com/developer/sdk/flutter/profile-data/sms-subscription-1.md)
- [Profile data migration](https://doc.batch.com/developer/sdk/flutter/profile-data/data-migration.md)
- [Testing your integration](https://doc.batch.com/developer/sdk/flutter/profile-data/debug.md)
- [Data Privacy](https://doc.batch.com/developer/sdk/flutter/data-privacy.md)
- [SDK opt-out (e.g. GDPR)](https://doc.batch.com/developer/sdk/flutter/data-privacy/opt-out.md)
- [Automatic data collection](https://doc.batch.com/developer/sdk/flutter/data-privacy/data-collection.md)
- [Advanced](https://doc.batch.com/developer/sdk/flutter/advanced.md)
- [Customizing notifications](https://doc.batch.com/developer/sdk/flutter/advanced/customizing-notifications.md)
- [Event dispatchers](https://doc.batch.com/developer/sdk/flutter/advanced/event-dispatchers.md)
- [Custom actions](https://doc.batch.com/developer/sdk/flutter/advanced/custom-actions.md)
- [Migrating from v1](https://doc.batch.com/developer/sdk/flutter/advanced/1x-migration.md)
- [SDK changelog](https://doc.batch.com/developer/sdk/flutter/sdk-changelog.md)
- [React Native](https://doc.batch.com/developer/sdk/react-native.md)
- [Prerequisites](https://doc.batch.com/developer/sdk/react-native/prerequisites.md)
- [SDK integration](https://doc.batch.com/developer/sdk/react-native/sdk-integration.md)
- [Vanilla Integration](https://doc.batch.com/developer/sdk/react-native/sdk-integration/vanilla-integration.md)
- [Expo Integration](https://doc.batch.com/developer/sdk/react-native/sdk-integration/expo-integration.md)
- [Rich notifications setup](https://doc.batch.com/developer/sdk/react-native/sdk-integration/rich-notifications-setup.md)
- [Huawei Push](https://doc.batch.com/developer/sdk/react-native/sdk-integration/huawei.md)
- [Messaging (In-App/Landings)](https://doc.batch.com/developer/sdk/react-native/messaging.md)
- [Inbox](https://doc.batch.com/developer/sdk/react-native/inbox.md)
- [Profile Data](https://doc.batch.com/developer/sdk/react-native/profile-data.md)
- [Attributes](https://doc.batch.com/developer/sdk/react-native/profile-data/attributes.md)
- [Events](https://doc.batch.com/developer/sdk/react-native/profile-data/events.md)
- [Custom user ID](https://doc.batch.com/developer/sdk/react-native/profile-data/custom-user-id.md)
- [Custom region/language](https://doc.batch.com/developer/sdk/react-native/profile-data/custom-locale.md)
- [Email subscription](https://doc.batch.com/developer/sdk/react-native/profile-data/email-subscription.md)
- [SMS subscription](https://doc.batch.com/developer/sdk/react-native/profile-data/sms-subscription.md)
- [Topic preferences](https://doc.batch.com/developer/sdk/react-native/profile-data/sms-subscription-1.md)
- [Profile data migration](https://doc.batch.com/developer/sdk/react-native/profile-data/data-migration.md)
- [Testing your integration](https://doc.batch.com/developer/sdk/react-native/profile-data/debug.md)
- [Data Privacy](https://doc.batch.com/developer/sdk/react-native/data-privacy.md)
- [SDK opt-out (e.g. GDPR)](https://doc.batch.com/developer/sdk/react-native/data-privacy/opt-out.md)
- [Automatic data collection](https://doc.batch.com/developer/sdk/react-native/data-privacy/data-collection.md)
- [Troubleshooting](https://doc.batch.com/developer/sdk/react-native/troubleshooting.md)
- [Advanced](https://doc.batch.com/developer/sdk/react-native/advanced.md)
- [Deeplinking](https://doc.batch.com/developer/sdk/react-native/advanced/deeplinking.md)
- [Event dispatchers](https://doc.batch.com/developer/sdk/react-native/advanced/event-dispatchers.md)
- [Customizing notifications](https://doc.batch.com/developer/sdk/react-native/advanced/customizing-notifications.md)
- [Overriding SDK Version](https://doc.batch.com/developer/sdk/react-native/advanced/sdk-version-override.md)
- [Migrating from v8](https://doc.batch.com/developer/sdk/react-native/advanced/8x-migration.md)
- [Migrating from v11](https://doc.batch.com/developer/sdk/react-native/advanced/11x-migration.md)
- [SDK changelog](https://doc.batch.com/developer/sdk/react-native/sdk-changelog.md)
- [Expo SDK changelog](https://doc.batch.com/developer/sdk/react-native/expo-sdk-changelog.md)
- [Cordova](https://doc.batch.com/developer/sdk/cordova.md)
- [Prerequisites](https://doc.batch.com/developer/sdk/cordova/prerequisites.md)
- [SDK integration](https://doc.batch.com/developer/sdk/cordova/sdk-integration.md)
- [Messaging (In-App/Landings)](https://doc.batch.com/developer/sdk/cordova/messaging.md)
- [Inbox](https://doc.batch.com/developer/sdk/cordova/inbox.md)
- [Profile Data](https://doc.batch.com/developer/sdk/cordova/profile-data.md)
- [Attributes](https://doc.batch.com/developer/sdk/cordova/profile-data/attributes.md)
- [Events](https://doc.batch.com/developer/sdk/cordova/profile-data/events.md)
- [Custom user ID](https://doc.batch.com/developer/sdk/cordova/profile-data/custom-user-id.md)
- [Custom region/language](https://doc.batch.com/developer/sdk/cordova/profile-data/custom-locale.md)
- [Email subscription](https://doc.batch.com/developer/sdk/cordova/profile-data/email-subscription.md)
- [SMS subscription](https://doc.batch.com/developer/sdk/cordova/profile-data/sms-subscription.md)
- [Topic preferences](https://doc.batch.com/developer/sdk/cordova/profile-data/sms-subscription-1.md)
- [Profile data migration](https://doc.batch.com/developer/sdk/cordova/profile-data/data-migration.md)
- [Testing your integration](https://doc.batch.com/developer/sdk/cordova/profile-data/debug.md)
- [Data Privacy](https://doc.batch.com/developer/sdk/cordova/data-privacy.md)
- [SDK opt-out (e.g. GDPR)](https://doc.batch.com/developer/sdk/cordova/data-privacy/opt-out.md)
- [Automatic data collection](https://doc.batch.com/developer/sdk/cordova/data-privacy/data-collection.md)
- [Advanced](https://doc.batch.com/developer/sdk/cordova/advanced.md)
- [Manipulating the Android Manifest from Cordova](https://doc.batch.com/developer/sdk/cordova/advanced/android-manifest-manipulation.md)
- [Customizing notifications](https://doc.batch.com/developer/sdk/cordova/advanced/customizing-notifications.md)
- [Intercepting notifications](https://doc.batch.com/developer/sdk/cordova/advanced/intercepting-notifications.md)
- [Overriding native SDK versions](https://doc.batch.com/developer/sdk/cordova/advanced/overriding-native-sdk-versions.md)
- [Event dispatchers](https://doc.batch.com/developer/sdk/cordova/advanced/event-dispatchers.md)
- [Migrations](https://doc.batch.com/developer/sdk/cordova/migrations.md)
- [Migrating from 5.0](https://doc.batch.com/developer/sdk/cordova/migrations/5x-migration.md)
- [Migrating from 4.0](https://doc.batch.com/developer/sdk/cordova/migrations/4x-migration.md)
- [Migrating from 2.3](https://doc.batch.com/developer/sdk/cordova/migrations/2x-migration.md)
- [Migrating from 1.0](https://doc.batch.com/developer/sdk/cordova/migrations/1x-migration.md)
- [SDK changelog](https://doc.batch.com/developer/sdk/cordova/sdk-changelog.md)
- [Support Policy](https://doc.batch.com/developer/sdk/support-policy.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://doc.batch.com/developer/sdk.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.