--- schema_version: "1" id: 617fcb1da1600be689c6a75f7a56e268b150eb3ca482fbdd2e49c7912c0814b3 title: Configure the Agentforce SDK for React Native collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/genai/agentforce-mobile-sdk/guides/react-native/agentforce-mobile-sdk-react-native-integration.md canonical_url: https://developer.salesforce.com/docs/ai/agentforce-mobile-sdk/guide/agentforce-mobile-sdk-react-native-integration.html source_site: developer.salesforce.com content_type: documentation content_hash: 397297700f71c6f344394aee7473c9df072be1907029a37d421873b22a776b5b products: - Agentforce Mobile SDK - Agentforce and Einstein Generative AI --- # Configure the Agentforce SDK for React Native Learn how to configure the Agentforce Mobile SDK for your React Native application. The SDK supports two modes: Service Agent for anonymous customer support, and Employee Agent for authenticated internal use. ## Overview The `configure()` method accepts a configuration object with a `type` field that determines the SDK's operating mode: ```tsx import { AgentforceService } from "@salesforce/react-native-agentforce"; await AgentforceService.configure({ type: "service", // or 'employee' // ... mode-specific fields }); ``` Both modes share `organizationId` and optional `featureFlags`. Other fields are specific to each mode. ## Service Agent Configuration Service Agent mode is for anonymous/guest access, typically for customer-facing support scenarios. No OAuth authentication is required. ### Configuration Fields | Field | Type | Required | Description | | ----------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | `'service'` | Yes | Must be `'service'` | | `serviceApiURL` | `string` | Yes | The Service API URL for your deployment. Found in Setup > Embedded Service Deployments > Settings. Must be a valid URL (for example, `https://your-site.salesforce.com`). | | `organizationId` | `string` | Yes | Your Salesforce Organization ID. Found in Setup > Company Information. Can be 15 or 18 characters. | | `esDeveloperName` | `string` | Yes | The developer name of your Embedded Service deployment. Found in Setup > Embedded Service Deployments. | | `featureFlags` | `FeatureFlags` | No | Optional feature flags. If omitted, persisted flags (or defaults) are used. | ### Example ```tsx await AgentforceService.configure({ type: "service", serviceApiURL: "https://mycompany-support.my.salesforce-scrt.com", organizationId: "00Dxx0000001234EAA", esDeveloperName: "My_Service_Agent", }); ``` ## Employee Agent Configuration Employee Agent mode is for authenticated, internal-use scenarios. Users must be authenticated with a valid Salesforce OAuth token. ### Configuration Fields | Field | Type | Required | Description | | ---------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------ | | `type` | `'employee'` | Yes | Must be `'employee'` | | `instanceUrl` | `string` | Yes | Your Salesforce instance URL (for example, `https://myorg.my.salesforce.com`). | | `organizationId` | `string` | Yes | Salesforce Organization ID. | | `userId` | `string` | Yes | The Salesforce User ID of the authenticated user (for example, `005xx0000001234`). | | `agentId` | `string` | No | The Agentforce Agent ID. If omitted and `enableMultiAgent` is true, the SDK picks the first available agent. | | `agentLabel` | `string` | No | A display label shown in the conversation UI title bar (Android). | | `accessToken` | `string` | No | OAuth access token. Can be provided directly or obtained via Mobile SDK auth. | | `featureFlags` | `FeatureFlags` | No | Optional feature flags. | ### Example: Direct Token ```tsx await AgentforceService.configure({ type: "employee", instanceUrl: "https://myorg.my.salesforce.com", organizationId: "00Dxx0000001234EAA", userId: "005xx0000001234AAA", agentId: "0Xxxx0000001234AAA", accessToken: "your_oauth_access_token", }); ``` ### Example: With Mobile SDK Auth When using the Mobile SDK for authentication, obtain credentials first and then pass them to `configure()`: ```tsx import { AgentforceService, loginForEmployeeAgent } from "@salesforce/react-native-agentforce"; // Login via Mobile SDK const creds = await loginForEmployeeAgent(); // Configure with obtained credentials await AgentforceService.configure({ type: "employee", instanceUrl: creds.instanceUrl, organizationId: creds.organizationId, userId: creds.userId, agentId: "0Xxxx0000001234AAA", accessToken: creds.accessToken, }); ``` See [Employee Agent Authentication](https://developer.salesforce.com/docs/ai/agentforce-mobile-sdk/guide/agentforce-mobile-sdk-react-native-employee-auth.md) for details on the Mobile SDK auth integration. ### agentId Behavior The `agentId` field determines which agent the conversation uses: - **If `agentId` is provided**, the conversation starts with that specific agent. - **If `agentId` is omitted and `enableMultiAgent` is `true`** (the default), the SDK bootstraps and picks the first available agent. - **If `agentId` is omitted and `enableMultiAgent` is `false`**, the conversation will likely fail. A warning is logged on both platforms. You can read and write the `agentId` independently of configuration: ```tsx // Read stored agent ID const storedId = await AgentforceService.getEmployeeAgentId(); // Set a new agent ID await AgentforceService.setEmployeeAgentId("0Xxxx0000005678AAA"); ``` **warning:** Platform Difference On **iOS**, calling `setEmployeeAgentId()` with a different agent ID triggers an immediate conversation close and client cleanup. The new agent ID takes effect right away. On **Android**, the method only persists the value. The change takes effect on the next `configure()` or `launchConversation()` call. ## Feature Flags Feature flags control optional SDK capabilities. They can be provided inline with the config or set independently. ```tsx interface FeatureFlags { enableMultiAgent: boolean; // default: true enableMultiModalInput: boolean; // default: false enablePDFUpload: boolean; // default: false enableVoice: boolean; // default: false enableCustomViewProvider: boolean; // default: false } ``` ### Flag Details | Flag | Default | Description | | -------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `enableMultiAgent` | `true` | When true and no `agentId` is specified, the SDK bootstraps and picks from available agents. When false, an `agentId` must be provided. | | `enableMultiModalInput` | `false` | Enables camera and image attachment capabilities in the conversation UI. Requires camera/photo permissions. | | `enablePDFUpload` | `false` | Enables PDF file upload in the conversation. | | `enableVoice` | `false` | Enables voice input (microphone) in the conversation UI. Requires microphone permission. | | `enableCustomViewProvider` | `false` | Enables the custom view provider system. When true and a `ViewProviderDelegate` is registered, the SDK delegates rendering of matched component types to your React Native components. | ### Setting Feature Flags **Inline with configure():** ```tsx await AgentforceService.configure({ type: "service", serviceApiURL: url, organizationId: orgId, esDeveloperName: devName, featureFlags: { enableMultiAgent: true, enableMultiModalInput: true, enablePDFUpload: false, enableVoice: false, enableCustomViewProvider: false, }, }); ``` **Independently (persisted):** ```tsx // Save flags -- they take effect the next time configure() is called await AgentforceService.setFeatureFlags({ enableMultiAgent: true, enableMultiModalInput: true, enablePDFUpload: true, enableVoice: false, enableCustomViewProvider: false, }); // Read current flags const flags = await AgentforceService.getFeatureFlags(); console.log(flags.enableMultiModalInput); // true ``` **note:** Changing feature flags via `setFeatureFlags()` does not take effect immediately. You must call `configure()` again (or restart the app) for changes to apply. ### Flag Resolution Order When `configure()` is called, feature flags are resolved in this order: 1. **If `featureFlags` is provided** in the `configure()` call, those values are used. 2. **If `featureFlags` is omitted**, the bridge reads persisted flags from native storage. 3. **If no persisted flags exist**, hard-coded defaults are used (`enableMultiAgent: true`, all others `false`). ## Configuration Lifecycle A typical configuration lifecycle: 1. Set delegates (logger, navigation, view provider) - optional, but do before `configure()` 2. Set hidden prechat fields - optional, Service Agent only, before launch 3. Call `configure()` - required 4. Check `isConfigured()` - optional verification 5. Call `launchConversation()` - opens UI 6. Call `setAdditionalContext()` - optional, after launching 7. Call `closeConversation()` or `startNewConversation()` - as needed 8. Call `destroy()` - on app shutdown When switching between modes (for example, from Service to Employee), calling `configure()` again with a different `type` automatically cleans up the previous client and conversation. ## Checking Configuration Status ```tsx // Check if configured const isConfigured = await AgentforceService.isConfigured(); // Get detailed configuration info const info = await AgentforceService.getConfigurationInfo(); if (info.configured) { console.log(`Configured in ${info.mode} mode`); } ``` ## See Also - [Conversations](https://developer.salesforce.com/docs/ai/agentforce-mobile-sdk/guide/agentforce-mobile-sdk-react-native-conversations.md) - [Delegates](https://developer.salesforce.com/docs/ai/agentforce-mobile-sdk/guide/agentforce-mobile-sdk-react-native-delegates.md) - [Employee Agent Authentication](https://developer.salesforce.com/docs/ai/agentforce-mobile-sdk/guide/agentforce-mobile-sdk-react-native-employee-auth.md) - [Troubleshooting](https://developer.salesforce.com/docs/ai/agentforce-mobile-sdk/guide/agentforce-mobile-sdk-react-native-troubleshooting.md)