Article Overview
The following steps are required to set up SalesRabbit's integration with AccuLynx.
Note: This integration is only available to customers on SalesRabbit's Pro or Enterprise membership plans. Additionally, administrative access is required in order to access API keys and other credentials/settings in configuring this integration.
Note: In order to access AccuLynx's API, you must have their AppConnections feature as part of your AccuLynx subscription. AccuLynx recently released their own integration with SalesRabbit that is available through AccuLynx's AppConnections. You do not need both of these integrations set up, just one.
Part 1: Form Creation
This part will cover how to create the form that is to be submitted when pushing lead information from SalesRabbit to AccuLynx. This integration requires that a rep submits a form to properly push lead information to AccuLynx.
- From the SalesRabbit Web App, navigate to "Settings" -> "Form Builder".
- This page will display all of the forms you have previously built.
- Select "+ New Form".
-
Create the form by:
- Naming the form in the upper left corner.
- Naming the section (usually "Lead Details").
- Clicking and dragging the following fields listed under the Lead or Form fields dropdown list:
| Field Name | Field Type | Required/Optional | Description | Field Key |
| First Name | Lead Field - First Name | Required | First name of customer | firstName |
| Last Name | Lead Field - Last Name | Optional | Last name of customer | lastName |
| Phone | Lead Field - Phone | Optional | Phone of customer | phonePrimary |
| Lead Field - Email | Optional | Email of customer | ||
| Street Address | Lead Field - Street Address | Optional | Street Address of customer | street1 |
|
Apt/Suite |
Lead Field - Street Address 2 | Optional | Street 2 of customer | street2 |
| City | Lead Field - City | Optional | City of customer | city |
| State | Lead Field - State | Optional | State of customer | state |
| Postal Code | Lead Field - Postal Code | Optional | Postal Code of customer | postalCode |
| Appointment Time | Lead Field - Date/Time | Optional | If there is an appointment and there is no sales person assigned, the appointment time will be added to the "Notes" field in AccuLynx | appointmentTime |
| Notes | Lead Field - Notes | Optional | Notes about the customer | note |
| AccuLynx Office Location | Form Field - Dropdown | Required* - see description | Required for multi-location customers. Lists different locations that will be selectable within the form. | AccuLynxOfficeLocation |
-
- Note: Field API name MUST match the example provided. All fields are required except Apt/Suite, Appointments, Notes, and Organization Names.
- Note: The AccuLynx Integration requires the AccuLynx Office Location "Form Field" dropdown. The name of the Office(s) MUST match in the AccuLynx integration wizard configuration.
- After creating your form, select the cogwheel icon in the upper left corner and turn on "Custom Form Results".
- Then "Publish" your form.
- Your form has now been published and is ready to use for this integration!
Part 2: Obtain AccuLynx API Token
This part will show how to create and obtain an API token from your AccuLynx account. Please note, this information may change depending on AccuLynx's system updates. Link to AccuLynx's API Documentation.
- Log in to your AccuLynx account (Be sure to log in to the correct AccuLynx Office).
- Select your name in the upper right corner -> click "Account Settings" from the dropdown menu.
- In the left hand menu, under "Add-On Features and Integration" -> select "API Keys" -> "View API Keys in AppConnections".
- From the AppConnections menu, click "Manage Connection" in the bottom right corner.
- On the Manage Connection Page, click "New" to create a new API key.
-
- Name the new key "SalesRabbit", spelling and capitalization are important.
- Choose your desired "Lead Source" (ex. Canvasser).
- Click "Create Key".
-
- Copy the new API Key by selecting the "Copy" button. You will need this key for the next steps in the AccuLynx Integration Configuration Wizard.
- You're now ready to run the AccuLynx configuration wizard in SalesRabbit!
Part 3: AccuLynx Configuration Wizard
This part will walk you through the AccuLynx Configuration Wizard on the SalesRabbit Web App. You can always make edits to this configuration wizard after you've set it up the first time.
- From the SalesRabbit Web App, navigate to "Integrations" -> "Marketplace" -> select the "Amplify" Integration card.
-
- Navigate to "Configuration" -> select "Enable".
-
-
Authorization Page:
- Select "New Authentication" and paste the AccuLynx API key that was copied from Part 2.
- Note: If you have multiple API keys, there is one way to map out your API Keys: by using a location dropdown that you create and that will be accessible via the form.
-
Authorization Page:
-
- Give your authentication a name and paste the copied AccuLynx API key from Part 2 of this article -> click "Create".
-
- Click "Next" after connecting your AccuLynx account to move onto the next page in the configuration.
-
Form Selection Page:
- Since this integration work via form submission, you must select the form users will submit to send lead information from SalesRabbit into AccuLynx.
- Under the Forms dropdown, select the published form created in Part 1 of this article from the dropdown list.
- Click "Next" to move onto the next page of the configuration.
-
Locations & Record Assignment Page:
- Each AccuLynx API key is associated with 1 AccuLynx Location. To support additional locations, you'll want to create more instances of the AccuLynx soution and associate them accordingly.
-
Additionally, only 1 of the following options can be selected. If none are selected, the integration will use the key you provided to authenticate your AccuLynx account on the 1st page of the configuration.
-
"Use SalesRabbit Organization Units":
- Allows SalesRabbit to send contacts and jobs to a specific AccuLynx Location using the user's organization assignment.
- When enabled, create a list of organization mappings between SalesRabbit and AccuLynx.
-
"Use SalesRabbit Organization Units":
-
-
"Use SalesRabbit Form Field":
- Allows SalesRabbit to send contacts and jobs to a specific AccuLynx location using a dropdown form field called "AccuLynx Office Location" on the form built in Part 1 of this article. When enabled, create a list of mappings between SalesRabbit and the AccuLynx API keys associated with that location.
- Be sure the Locations entered match the dropdown values of your form field exactly. You can also select "Use User Email" to assign the salesman in AccuLynx based on the email provided by the form submitter.
-
"Use SalesRabbit Form Field":
-
- SalesRabbit can assign a record using the AccuLynx 'SalesPerson' key when creating a lead record. To do this, we must send the Login email address of the active user in AccuLynx to whom the lead/job should be assigned.
-
The default method is to "Use User Email" of the Lead Owner in SalesRabbit. If this does not work with your business case, you can uncheck this option and set an External ID on the SalesRabbit user with the desired login email to use. View Part 5 of this article for how to add an "External ID" to a SalesRabbit User.
- Note: if no email address is provided, the lead will be unassigned in AccuLynx.
-
- Click "Next" to move onto the next page of the configuration.
-
Custom Field Mapping Page:
-
"Add Custom Fields to AccuLynx Notes":
- Checking this box will send information from Custom Fields to the AccuLynx contact notes. If enabled, use the "+Add Custom Field" button to generate a list of custom fields you'd like the information to pass over into the contact notes.
-
"Add Custom Fields to AccuLynx Notes":
-
- "Change SalesRabbit Status":
- Checking this box will enable the automatic status change of the lead in SalesRabbit when the form is submitted. If enabled, you'll need to select the status to update your leads to.
- Note: ALL leads will default to this status after submitting the form to send to AccuLynx.
- "Change SalesRabbit Status":
-
- Click "Finish" to complete/save changed made to the configuration.
- If you wish to disable or reconfigure this integration at any time you can do so by clicking "Disable" or "Reconfigure" respectively. Additionally, if the integration is currently live you should see an "enabled" indicator on the integration.
Part 4: Adding an External ID
This part will demonstrate how to add an AccuLynx user's email to a SalesRabbit user's External ID. If you've unchecked the "Use User Email" user assignment option in the configuration, admins can add an AccuLynx user email to a SalesRabbit user's "External ID" for user assignments.
- From the SalesRabbit Web App, navigate to "Users" -> select the user you'd like to set an external ID for.
- From the user's detail page, add the AccuLynx user's email address to the "External ID" field -> click "+ Add".
- Note: if you add the an email to the external ID and is it NOT an AccuLynx user's email, the submission will fail.
Your AccuLynx integration should now be live and allow you to create leads in AccuLynx through form submission! If you have any issues or problems please reach out to support or your CSM for help configuring this integration.
Pro Tips
- AccuLynx recently released their own integration with SalesRabbit. Users do NOT need to set up both integrations, just one. Here's information on AccuLynx's SalesRabbit integration.
If needed, link to the next section: Help Center Section