Integrate with Salesforce

DreamApply utilizes the Connected apps framework to integrate with Salesforce. This framework allows external systems to securely connect and access Salesforce data using standard authentication and authorization methods.

During the export process, DreamApply can send the following data:

• Applicant data: ID, name, first name, last name, email, phone, registration date, citizenship, reference and matriculation
• Lead data: Lead stage and stage change date
• Programme data: Programme IDs
• Academic term data: Name, year, type and start date
• Dates: Dates and UTC dates values

The exported data is registered as lead records in Salesforce and linked to a specific contact owner. You can map DreamApply applicant fields to corresponding fields of Salesforce records.

To import lead data to DreamApply, perform the following tasks:

1. Obtain a DreamApply certificate
2. Create a new connected app
3. Obtain the Salesforce instance details
4. Configure integration settings

Before you begin

To integrate with DreamApply, your account must have the Superuser role or the integrations permission.

Obtain a DreamApply certificate

DreamApply uses a digital certificate for certificate-based authentication with Salesforce. The certificate ensures that only trusted systems can retrieve data from Salesforce.

Download a certificate using the following link: https://<your-dreamapply-instance>/admin/instance/certificate and save it on your computer.

Create a new connected app

To enable integration between DreamApply and Salesforce, you must create a connected app in your Salesforce account. The connected app provides the credentials and authentication settings that allows DreamApply to securely access your Salesforce data.

1. Log in to your Salesforce account.

2. In the top right corner of the Salesforce portal, click the gear icon and select Setup.

3. In the left pane, under Platform Tools > External Client Apps, select Settings.

4. In the Connected Apps section, make sure the Allow creation of connected apps option is enabled and click New Connected App.

   

5. In the Basic information section, specify the connected app name, API name and contact email for the connected app.

   

6. Select the Use digital signatures check box and upload the DreamApply certificate you downloaded earlier.

7. In the API (Enable OAuth Settings) section:

   1. Select the Enable OAuth Settings check box.

   2. In the Callback URL field, specify https://dreamapply.com. This field is required by Salesforce but will not be actually used for integration.

   3. In the Selected OAuth Scopes, choose the following scopes:

      • Manage user data via APIs (api)
      • Perform requests at any time (refresh token, offline access)

   4. Save the settings.

   

8. In the displayed view, click Manage and then Edit policies.

   

9. In the OAuth Policies section, from the Permitted Users list, select Admin approved users are pre-authorized.

   

10. In the connected app details view, in the Profiles section, click Manage Profiles.

    

11. In the Application Profile Assignment view, select a profile that represents a user account DreamApply will use to connect to Salesforce. You can use the System Administrator profile that has full access or create a dedicated integration profile with a more restricted permission set. For details, see Create or Clone Profiles in the Salesforce documentation.

    

12. Save the settings.

Obtain the Salesforce instance details

You need to obtain the following details to connect DreamApply to your Salesforce instance:

• Instance URL
• Consumer Key
• Username

Get the instance URL

To get the instance URL:

1. In the left menu, select Settings > Company Settings > My Domain.
2. Make note of and copy the My Domain URL value.

Get the Consumer key

To get the Consumer key for your connected app:

1. In the left menu, select Apps > App manager.

2. To the right of the created connected app, click the arrow icon and select View.

3. In the API (Enable OAuth Settings) section, click Manage Consumer Details.

   

4. Make note of and copy the Consumer Key value for the connected app.

   

Get a Salesforce username

You need to get a Salesforce username of the account that DreamApply will use to connect to Salesforce. This username must be tied to the profile assigned to the connected app — the System Administrator or a dedicated integration profile with a more restricted permission set.

To get a Salesforce user name:

1. In the left menu, select Administration > Users > Users.
2. Select to view the necessary user account.
3. Make note of and copy the Username value.

Configure integration settings

To connect to Salesforce in DreamApply:

1. In the main menu, under Marketing, select Integrations.

2. Select Outgoing integrations > Salesforce.

3. Specify the connection details you obtained earlier:

   • Instance URL, for example, https://orgfarm-abcabc11234-dev-ed.develop.my.salesforce.com
   • Consumer Key
   • Username

4. At the top of the form, click Save changes.

   

5. In the Data mapping section, specify how DreamApply applicant data must map to Salesforce lead fields.

   Salesforce requires the Last Name and Company fields for a lead record. Other required fields depend on your organization setup.

6. In the Consent section, specify if applicant consent is required to send data to Salesforce.

7. In the Send by default section, select the Send all new applicants automatically check box to enable continuous integration between DreamApply and Salesforce. If you do not enable this option, you will need to set up rules or send applicant data manually. For details, see Send applicant data.

   From the list below, select a contact owner to which created lead records must be linked.

8. In the Automatic updates section, select the Update applicant records automatically check box to keep lead records in sync with the DreamApply system. For details, see Send applicant data.

9. In the Technical contact field, specify an email address for technical support. DreamApply will send error descriptions to this address if any integration issues occur.

10. At the top of the form, click Save changes.