Getting started
Before you begin, ensure you have the following:- A Salesforce Account: Administrator access to a Salesforce account.
- PolyAI Access: Access credentials for the PolyAI Portal.
Set up Salesforce for API access
Follow these steps to enable API access in Salesforce:- Enable API Access:
- Log in to Salesforce with admin privileges.
- Go to Setup > Users > Profiles.
- Edit the profile for the user account that will connect to PolyAI.
- Ensure the checkbox for API Enabled is selected.
- Create a Connected App:
- Go to Setup > App Manager.
- Click New Connected App.
- Fill in the following details:
- Connected App Name:
PolyAI Integration. - API Name:
PolyAIIntegration. - Contact Email: Enter your email.
- Enable OAuth Settings: Check this box.
- Callback URL: Enter a valid callback URL for your organization. This can be any HTTPS URL you control (e.g.,
https://yourcompany.com/oauth/callback). For PolyAI integrations, this URL is not actively used but is required by Salesforce OAuth configuration. - Selected OAuth Scopes: Add
Full Access (full)andPerform requests on your behalf at any time (refresh_token, offline_access).
- Connected App Name:
- Save the connected app and note the Consumer Key and Consumer Secret.
- Provide PolyAI with the Required Information:
- Client ID: The Consumer Key of your Connected App.
- Client Secret: The Consumer Secret of your Connected App.
- Username: The Salesforce username for the integration.
- Password: The Salesforce password for the user, appended with the security token.
- Access Token URL: Typically
https://login.salesforce.com/services/oauth2/token(for production) orhttps://test.salesforce.com/services/oauth2/token(for sandbox). - Base URL: The root URL of your Salesforce instance (e.g.,
https://your_instance.salesforce.com).
access_token. Credentials will be passed in the Authorization header as specified in the OAuth spec.

