This tutorial covers how to request access, set up, and utilize Aurora's Exit to CRM button.
Table of Contents
How It Works
From any page in Sales Mode, a user has the option to go directly to the associated Project or Design record in their own CRM. Upon clicking Exit → CRM, the user is taken to the Admin-configured URL in the same browser tab. This allows for seamless navigation between platforms in an existing solar ecosystem.
Key Terms
CRM - Customer Relationship Management tool
Asynchronous events - Some API actions take too long to be completed synchronously (i.e. returned immediately) in an HTTP Request. We refer to such actions as asynchronous and have a shared pattern for API endpoints when handling them.
Getting Started
💡 First, your tenant will need access to this feature. Please reach out to your account team for more information.
Once the Exit to CRM button has been enabled for your tenant, a shortcut URL can be provided in the Organization Profile section under Account → Organization profile → Exit to CRM by clicking the Edit button in the top right-hand corner of the page.
A projectid and designid can be dynamically referenced in the URL by using brackets.
💡 Example URL: https://mysolarapp.com/projects/{projectid}/designs/{designid}/proposal
Webhooks Involved
You may choose to host a button/action in your CRM for users to click to sync data from Aurora to your CRM upon being redirected after clicking Exit to CRM in Aurora. You can also enable asynchronous information to be continuously passed from Aurora to your CRM through webhook notifications. This way, design information from Aurora is already up-to-date in your CRM by the time a user clicks Exit → CRM in Sales Mode.
It is recommended that developers consider the list of available webhooks to decide which events your CRM would benefit from subscribing to. The most common webhook to subscribe to in an Exit to CRM workflow would be ‘Performance Simulation Job Completed’, indicating that Performance Simulation has successfully run in Aurora. In this example instance, once this webhook fires a notification to your CRM, pulling information from the response of Retrieve Design Summary would enable your CRM to host up-to-date design info upon each recalculation of offset in Aurora Sales Mode.
Considerations
One recommended way to create a link between an Aurora Project/Design and the corresponding record in your CRM is to set the record ID in your CRM to be the same ID as the object in Aurora.