Article Overview
The following steps are required to set up SalesRabbit's integration with AccuLynx. This integration is available to customers on SalesRabbit's Pro or Enterprise 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: Custom Fields
This part will cover how to create custom fields in SalesRabbit. Some of these fields are required.
- From the SalesRabbit Web App, navigate to "Settings" -> "Custom Lead Fields".
- Create the following custom fields:
Field Name |
Field Type |
Description |
Required? |
AccuLynx Job ID |
API |
This field will auto-fill with the AccuLynx Job ID post-submission. This field is required if creating jobs with the integration. |
Yes |
AccuLynx Job Category |
Dropdown |
Use dropdown fields whose options match the names in AccuLynx exactly; values that don't match are skipped. |
No |
AccuLynx Work Type |
Dropdown |
Use dropdown fields whose options match the names in AccuLynx exactly; values that don't match are skipped. |
No |
AccuLynx Trade Type |
Dropdown |
Use dropdown fields whose options match the names in AccuLynx exactly; values that don't match are skipped. |
No |
Job Value |
Currency |
This field will auto-fill with the job value when the AccuLynx Job's Job Value has been entered. |
No |
- Below is a screenshot of what these fields will appear as.
- Click the "Publish" button to save these new fields.
Part 2: 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".
- 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 |
AccuLynx Job Category |
Lead Field - Dropdown |
Optional |
Job Category for the customer. |
accuLynxJobCategory |
AccuLynx Work Type |
Lead Field - Dropdown |
Optional |
Work type for the customer. |
accuLynxWorkType |
AccuLynx Trade Type |
Lead Field - Dropdown |
Optional |
Trade type for the customer. |
accuLynxTradeType |
AccuLynx Job ID |
Lead Field - API |
Required |
Will auto-fill with the Job ID post-submission. |
accuLynxJobID |
- Note: Field API name MUST match the example provided.
- 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.
- Select the cogwheel icon in the upper left corner and enable "Custom Form Results" -> Click the "Publish" button to complete the form.
- The form has now been published and is ready to use for this integration!
Part 3: 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 4: 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".
-
Authentication & Form Selection Page:
-
Connect your AccuLynx account:
- Select "New Authentication" and paste the AccuLynx API key that was copied from Part 3.
-
Connect your AccuLynx account:
-
Webhook Notification Contact Email:
- AccuLynx requires a technical contact email for the webhook subscription this integration creates. AccuLyx may use it to contact you about that subscription. Use an inbox your team monitors.
-
Form Selection:
- Use the "+ Add ID" dropdown to select the form this integration will use to push leads from SalesRabbit to AccuLynx. Select the form created in Part 2 of this article.
- Click the "Next" button to move onto the next page of the configuration.
-
Locations & Job Creation Page:
- If you have more than one location within AccuLynx, decide whether to "Use SalesRabbit Organization Units" or "Use SalesRabbit Form Field" to map locations.
-
Use SalesRabbit Organization Units:
- Use the "+ Add Mapping" button to map SalesRabbit Organizations to AccuLynx Locations.
-
Use SalesRabbit Organization Units:
- If you have more than one location within AccuLynx, decide whether to "Use SalesRabbit Organization Units" or "Use SalesRabbit Form Field" to map locations.
-
Use SalesRabbit Form Field:
- Note: if using this option, ensure that your form has an "AccuLynx Office Locations" dropdown form field with the appropriate options.
- Use the "+ Add Mapping" button to map AccuLynx Locations to AccuLynx API Key.
-
AccuLynx Jobs:
- By default, this integration will only create a Contact within AccuLynx.
- Enabling this option allows SalesRabbit to create an AccuLynx Job along with the contact. If enabled, additional settings will need to be configured.
-
SalesRabbit Lead Status:
- Enabling this option will automatically update the SalesRabbit lead after it's sent to AccuLynx.
- If enabled, select a status the SalesRabbit lead will auto-update to post submission.
- Click the "Next" button to move onto the next page of the configuration.
-
Contact Records Page:
-
Configure AccuLynx Contact Records:
- Use Default Standard Fields:
- When enabled, this option will automatically map the lead default fields (name, email, phone, address) to the AccuLynx contact fields.
- If disabled, a new page will appear in the configuration allowing users to manually map SalesRabbit default fields to AccuLynx contact fields.
- Use Custom Fields:
- When enabled, manually map SalesRabbit custom fields to AccuLynx contact custom fields.
- If disabled, custom fields will not pass over to AccuLynx contact fields.
- Use Default Standard Fields:
-
Configure AccuLynx Contact Records:
-
Lead Sync:
- When enabled, SalesRabbit leads are sent to AccuLynx when the lead's status is updated to select statuses. Use the "+ Add" button to select which lead statuses act as the trigger to send.
- If disabled, users will submit lead information from SalesRabbit to AccuLynx using form submission.
- Click the "Next" button to move onto the next page of the configuration.
-
Job Records Page:
- Note: this page will only appear if Job Creation was enabled.
-
Lead Source:
- Every new job created will be marked with a lead source. Use the dropdown to select the lead source very new job will be created with.
-
Job Category, Work Type & Trade Type:
- To send these fields to AccuLynx, they must exist as a SalesRabbit custom field with these exact names: AccuLynx Job Category, AccuLynx Work Type, and AccuLynx Trade Type. Use dropdown fields whose options match the names in AccuLynx exactly; values that don't match are skipped.
- Note: revisit Part 1 of this article for information on creating these custom fields.
- Use the "+ Add Mapping" button to map SalesRabbit Custom Fields to AccuLynx Job Fields.
- To send these fields to AccuLynx, they must exist as a SalesRabbit custom field with these exact names: AccuLynx Job Category, AccuLynx Work Type, and AccuLynx Trade Type. Use dropdown fields whose options match the names in AccuLynx exactly; values that don't match are skipped.
- Click the "Next" button to move onto the next page of the configuration.
-
Additional Job Settings Page:
-
Rep Reassignment:
- When a new job is created, it is assigned based on the SalesRabbit Lead Owner.
- Note: if no AccuLynx user matches, the job will created unassigned.
- Enable "Use User Email" to match reps to AccuLynx users by email.
- Disabling the option will match using a SalesRabbit user's External ID instead.
- When a new job is created, it is assigned based on the SalesRabbit Lead Owner.
-
Rep Reassignment:
-
Initial Appointment:
- If a lead has an appointment time, SalesRabbit sets it as the AccuLynx Job's initial appointment.
- Enter the default appointment length (in minutes) in the field.
-
File Upload:
- Allows SalesRabbit to add the lead's photos and files to the AccuLynx Job.
- Photos and videos go to Photos & Videos; other files go to the document folder.
- Leave the folder blank to have one picked automatically.
- Note: files are sent shortly after the job is created.
- Click the "Next" button to move onto the next page of the configuration.
-
Job Updates to SalesRabbit Page:
-
Enable 2-way Syncing with AccuLynx Jobs:
- Milestone Sync:
- Use the "+ Add Mapping" button to map AccuLynx milestones to SalesRabbit statuses.
- When a job milestone is updated from AccuLynx, the mapping will automatically update the lead's status in SalesRabbit.
- Milestone Sync:
-
Enable 2-way Syncing with AccuLynx Jobs:
- Job Value Sync:
- Enabling this option allows AccuLynx to update the lead in SalesRabbit with the job's approved value whenever it changes.
- Note: In order to use this feature, create a "Job Value" SalesRabbit custom lead field (Part 1).
- Click the "Finish" button to complete the integration setup or save any changes made to the integration settings.
- 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.
Adding an External ID
This part demonstrates 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 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.
Related to