Embedded Service Chat SDK for iOS Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Embedded Service Chat SDK for iOS Developer Guide
Release Notes
Service Cloud Setup
Chat with Lightning Experience
Get Chat Settings from Your Org
Chat with Salesforce Classic
SDK Setup
iOS Tutorials & Examples
Chat
SDK Customizations
Troubleshooting
Data Protection and Security
Reference Documentation
Additional Resources
PDF

Get Chat Settings from Your Org

After you’ve set up chat in the console, supply your app developer with four values: the chat endpoint hostname, the organization ID, the deployment ID, and the button ID. You can get this information from your org’s setup.

The legacy chat product is scheduled for retirement on February 14, 2026, and is in maintenance mode until then. During this phase, you can continue to use chat, but we no longer recommend that you implement new chat channels. To avoid service interruptions to your customers, migrate to Messaging for In-App and Web before that date. Messaging offers many of the chat features that you love plus asynchronous conversations that can be picked back up at any time. Learn about chat retirement in Help.

Important

If the endpoint for your server changes (due to an org migration, for example), the SDK automatically reroutes you to the correct server. However, to avoid unnecessary rerouting, you should still update the server endpoint when you notice it has changed inside your org’s settings.

Note

Chat Endpoint Hostname
The hostname for the Chat endpoint that your organization has been assigned. To get this value, from Setup, search for Chat Settings and copy the hostname from the API Endpoint.

Pod hostname

Be sure not to include the protocol or the path. For instance, if the API Endpoint is:

https://d.gla5.gus.salesforce.com/chat/rest/

The chat endpoint hostname is:

d.gla5.gus.salesforce.com
Org ID
The Salesforce org ID. To get this value, from Setup, search for Company Information and copy the Salesforce Organization ID.

Org ID

Deployment ID
The unique ID of your Chat deployment. To get this value, from Setup, select Chat | Deployments. The script at the bottom of the page contains a call to the liveagent.init function with the pod, the deploymentId, and orgId as arguments. Copy the deploymentId value.

Deployment ID

For instance, if the deployment code contains the following information:

<script type='text/javascript' 
        src='https://d.gla3.gus.salesforce.com/content/g/js/44.0/deployment.js'></script>
<script type='text/javascript'>
liveagent.init('https://d.gla5.gus.salesforce.com/chat', '573B00000005KXz', '00DB00000003Rxz');
</script>

The deployment ID value is: 

573B00000005KXz

Be sure not to use the org ID value (which is also in this deployment code) for the deployment ID.

Button ID
The unique button ID for your chat configuration. To get this value, from Setup, search for Chat Buttons and select Chat Buttons & Invitations. Copy the id for the button from the JavaScript snippet.

Button ID

For instance, if your chat button code contains the following information:

<a id="liveagent_button_online_575C00000004h3m" 
   href="javascript://Chat" 
   style="display: none;" 
   onclick="liveagent.startChat('575C00000004h3m')">
   <!-- Online Chat Content -->
</a>
<div id="liveagent_button_offline_575C00000004h3m" 
     style="display: none;">
     <!-- Offline Chat Content -->
</div>
<script type="text/javascript">
  if (!window._laq) { window._laq = []; }
  window._laq.push(function() { liveagent.showWhenOnline('575C00000004h3m', 
    document.getElementById('liveagent_button_online_575C00000004h3m'));
    liveagent.showWhenOffline('575C00000004h3m', 
    document.getElementById('liveagent_button_offline_575C00000004h3m'));
  });
</script>

The button ID value is: 

575C00000004h3m

Be sure to omit the liveagent_button_online_ text from the ID when using it in the SDK.