By using our Salesforce package integration, you are able to track referrals, trigger commissions, bi-directionally sync data and much more. With this integration, we offer configuration options for mapping data from Ambassador to Salesforce as outlined below.
Before setting up the integration, you’ll want to make sure you have fulfilled the following requirements:
- Ambassador Contract with Salesforce Package included*
- Ambassador Salesforce package installation code* (for production installation)
- User credentials for Ambassador with Admin level access
- Salesforce Account (Classic mode will be required for installation only)
- Salesforce Admin access level (to install package)
- Payment Information (for checkout purposes- be sure to use your code to avoid any charges)
*For questions regarding your contract or code, please contact your Success Coach and/or your Account Manager.
How do I set up the Ambassador Salesforce Package integration?
Follow the steps below to integrate your Salesforce account with our Ambassador Salesforce Package. Please note, you will need Admin level access in Salesforce and in Ambassador to install the package.
Additionally, when installing in sandbox, you will not be asked to provide payment, however, when installing in production you will be prompted for payment information and will need to use your Salesforce code for free* installation.
*If you do not use the package code, you will be charged via the Salesforce AppExchange. Please contact your Success Coach and/or Account Manager if you have questions on retrieving your code.
- Step 1: Visit the Salesforce AppExchange to download the “Ambassador Referral, Partner & Affiliate Tracking- Management Platform” Salesforce Package.
- Step 2: Select the green “Get It Now” button, located on the right side of the screen.
- Step 3: Select the blue “Install in Sandbox” option as shown below.
Please note, we recommend installing in sandbox prior to installing in production. Installing in sandbox first is especially important if you have campaigns that are in “test” mode within Ambassador.
TIP: Test campaigns will automatically connect to a sandbox org and live campaigns will automatically connect to a production org.
- Step 4: When prompted, enter your Salesforce login information.
- Step 5: Select “Install for All Users” or “Install for Specific Profiles” and click “Install.” Please note, access can be edited later, if necessary.
- Step 6: Once prompted, select “Yes, grant access to these third-party web sites” and click “Continue.”
- Step 7: In Salesforce, go to the “Ambassador Setup” tab along the top of the screen.
TIP: If this tab does not appear in the bar, you can search for the tab by clicking on the “+” sign.
- Step 8: Click the blue “Login” button and select “Allow” to authenticate the package in Salesforce.
- Step 9: Then, using credentials of a user who has Admin access to Ambassador, log in to the Ambassador platform to connect and finalize the authentication of Ambassador and your Salesforce account.
How will my records be created in Salesforce for ambassadors?
Once you’ve completed the installation, you will then need to configure your package to meet your particular needs in the “Ambassador Setup” tab within Salesforce. This process determines how the information is created in Salesforce from Ambassador.
Step 1: Determine how you want Ambassadors to be created in Salesforce. When deciding which of the two options works best, you’ll want to consider any reporting you may plan on doing in the future.
Option 1: Consider creating ambassadors as Contacts if you have one of the following use cases:
- You are running a customer program and you are creating contacts as Contacts in Salesforce already. Please note, this does not apply to Person Accounts.
- You are running an influencer, affiliate or partner program and you are interested in creating those users as Contacts that are assigned to the “Ambassador” account record.
If you have ambassadors that already exist as a Contact record, Ambassador is able to update the existing record with the ambassador’s memorable URL.
For ambassadors that do not exist, the package will create a record for them. We recommend choosing to "Assign all ambassadors to Ambassador Account" to keep all of the created Contacts in one place. Alternatively, you may choose for "each ambassador to get their own Account" which will create an Account record for each Contact, although this option is not typically recommended.
Option 2: Consider creating ambassadors as “Ambassador” Custom Objects if you have one of the following use cases:
- You are running an influencer, affiliate or partner program and do not want the ambassadors created as Contacts in Salesforce.
- You want to keep your referral activity for an ambassador separate from their existing Contact record.
- You are using a Person Account instead of Contacts. Please note, this option is not recommended.
By selecting Option 2, it will create an “Ambassador” record for the ambassador regardless of whether they currently exist. If the ambassador already exists, a link will be on the Ambassador record that leads to the Contact record.
TIP: You are still able to use Ambassador’s Salesforce Package if you do not use Leads, Contacts, Person Accounts, or Opportunities. If this is your use case, you should create ambassadors as the “Ambassador” Custom Object, not Contacts.
Step 2 (Optional): Decide if any of the additional settings listed below are beneficial to your use case. These options are located within your “Ambassador Setup” tab in Salesforce. Please note, the settings below are based on your specific use case; not all settings will apply.
- Lead Field Mapping: This setting is only applicable if you are using the “Lead Creation” trigger to create a commission via the Ambassador Salesforce package. For example, if you are looking to generate a commission when a lead is created.
- Automated Campaign Options: You may choose this setting if you are interested in accessing the “Ambassador Campaigns” tab to set-up the package triggers for commission (Lead creation, Lead conversion, Contact creation, or Positive Opportunity Stage).
Please note, the campaign must first be created in Ambassador. Additionally, you’ll want to save any changes in “Ambassador Setup” prior to selecting the “Click Here” button under this section.
For more information on how to set up Automated Campaign Options, please scroll down to this section below: “What event will take place in Salesforce to create commissions in Ambassador if I’ve selected Automated Campaign Options?”
- Web-To-Lead Tracker: This setting is applicable if you are specifically using a Salesforce Web-to-Lead form on your website. You will copy the Web-To-Lead tracking code and apply it to your form. Follow the instructions in the “Ambassador Setup tab” in Salesforce to set this option up. Please note, you’ll want to make sure you are using your own form ID.
- Initial Ambassador Import: If you have existing ambassadors in your Ambassador account, this will allow you to sync those existing contacts over to Salesforce. For example, if you have existing ambassadors in your referral program prior to integrating with Ambassador’s Salesforce package.
Please note, after this import any new ambassadors will be automatically synced. Additionally, this option requires a large amount of API calls. Be sure to check your API limits prior to selecting this option.
What event will take place in Salesforce to create commissions in Ambassador if I’ve selected Automated Campaign Options?
After you’ve determined the most effective way to create contacts, you will want to configure the Automated Campaign Options. If you have exited the “Ambassador Set-up” tab, you are able to reach your campaigns by selecting the “Ambassador Campaign Tabs” in Salesforce.
In this section, you will find all of your campaigns in Salesforce that are associated with your Ambassador account. This section will allow you to determine when the commission will be triggered. Keep in mind, if you are in your sandbox Salesforce, only Ambassador campaigns in test mode will appear. If you are in production, only campaigns in live mode will appear. Please note, if you do not see the campaigns listed, make sure to select the “All” view.
Within each campaign, you’ll want to select a trigger to create a pending commission in Ambassador.
Step 1: Click “Edit” on the “Campaign Detail” page, and select your pending commission trigger for your record type:
- Lead Commission: When a Lead record is created or updated with a Referring Short Code or Referring Contact/Referring Ambassador, a commission will be created.
- Conversion Commission: When a Lead record with a Referring Short Code or Referring Contact/Referring Ambassador is converted to an Account, Contact, and Opportunity, a commission will be created.
- Contact Commission: When a Contact record is created or updated with a Referring Short Code or Referring Contact/Referring Ambassador , a commission will be created
You may also select an opportunity stage and/or a delay to additionally be met in order to trigger the commission.
- Positive Opportunity Stage: This field can be utilized when an Opportunity record with a Referring Short Code or Referring Contact/Referring Ambassador is set with a specific Opportunity Stage, such as “Closed Won.” Please note, the drop down in this Salesforce field will populate your opportunity stage options.
- Wait Until Opportunity Amount is Set: This selection requires that the “Positive Opportunity Stage” (above) is set, as well as the field selected in the “Positive Opportunity Commission Type” field. For example, if you are using percentages for your commissions, this selection requires that not only does the “Positive Opportunity Commission Type” be set to trigger, but also that the Opportunity amount be set in order to trigger the commission.
TIP: If utilizing the “Approved Positive Opportunity Commission” field, we strongly recommend keeping this field set to “Use Campaign Settings.”
When utilizing the “Positive Opportunity Stage” and “Wait Until Opportunity Amount is Set” fields, there are a few additional commission settings you will want to consider for your workflow. If you are not utilizing the Positive Opportunity Stage option, you may move onto the next step.
Step 2: If you selected “Positive Opportunity Stage,” determine your “Positive Opportunity commission type.”
- Revenue - Opportunity Amount: This option will be the default option. By selecting this type, it will populate the opportunity amount as the revenue for the commission.
- Commission Amount: Select this type if the commission is a varying amount, but not a percentage. This allows you to communicate to Ambassador how much you want to reward for the commission.
Then, decide if you want to wait until the opportunity amount is set.
- Check the box if you are rewarding a percentage commission based on the “Opportunity Amount.”
- If the “Positive Opportunity Commission Type” is selected to “Commission Amount.”
Finally, decide if you want to limit which Positive Opportunity record types are eligible for earning a commission. For example, a common use case would be if you wanted to limit the eligibility for earning a commission by new sales versus renewals.
For more advanced use cases, please contact your Success Coach.
Where will Salesforce store Ambassador’s data?
Lastly, you’ll want to map Ambassador’s package fields to the Salesforce Standard Objects you will be using. This allows you to determine where the information for Ambassador will be stored on the record. Below is a list of package fields based on how you’re creating ambassadors.
Creating ambassadors as Contacts
If you’re creating ambassadors as Contacts, you’ll want to utilize the following available field according to your layout type:
- Lead Page Layout: Add the “Referring Contact” and “Referring Short Code” fields.
- Contact Page Layout: Add the “Referring Contact” and “Referring Short Code” fields.
However, if you’re creating ambassadors as Contacts and the contact is enrolled, these fields will also be available:
- Ambassador Referral Memorable URL
- Ambassador ID
- Remote Customer ID
- Ambassador Customer Label #1
- Ambassador Customer Label #2
- Ambassador Customer Label #3
- Button: Create Ambassador
- Button: Create Commission
- Related List: Commissions
- Opportunity Page Layout: Add the “Referring Short Code” and “Referring Contact” fields.
If your use case requires you to tell us the commission amount you want to reward when creating a commission using the "Positive Opportunity Stage" trigger, rather than using the campaign’s commission settings inside of Ambassador, then you’ll need to add the “Positive Opportunity Commission Amount” field to the page layout as well. Your team will need to populate the commission amount in that field as it will not auto-populate on its own.
Please note, if you are adding the referring short code in that field on the Contact record or Opportunity record directly, instead of to a Lead record first, then the “Referring Contact” field will not auto populate with the ambassador’s name.
Creating ambassadors as Ambassador Custom Objects
If you’re creating ambassadors as the “Ambassador” Custom Object, you’ll want to utilize the following available field according to your layout type:
- Lead Page Layout: Add the “Referring Ambassador” and “Referring Short Code” fields.
- Contact Page Layout: Add the “Referring Ambassador” and “Referring Short Code" fields.
- Opportunity Page Layout: Add the “Referring Ambassador” and “Referring Short Code” fields.
How will I capture the short code to create a referral?
In order to track referrals, you will need to capture the ambassador’s short code. To capture this information, follow the steps below. Please note, this section may require a technical resource from your team.
Step 1: You will need to create a hidden field on your website’s lead form to capture the ambassador’s short code.
The “getReferrerinfo” method will provide the referring ambassador’s short code, which you will need to pass into the hidden field you’ve created to hold the short code.
Step 3: The hidden field will need to be mapped to the “Referring Short Code” field on the Lead or Contact record that’s created when the form is submitted and synced to Salesforce.
After you’ve completed these steps, the “Referring Ambassador” or “Referring Contact” field will auto-populate with the ambassador’s email or name based on the "Referring Short Code." Once the “Referring Short Code” is populated in the Lead or Contact record, Ambassador’s Salesforce package integration will populate the information on any opportunities associated with that Lead or Contact.
Please note, it is not necessary to capture the Campaign ID. Additionally, there is not a field in Ambassador’s SF package to map this field over directly, a custom field would be required to display this information.