Webhooks & How to Use Them
Webhooks are used to automatically synchronize data between various softwares. If you would like to have your leads automatically flow into your CRM, project management tool or other software follow the below steps.
Step 1: Login to your Aerialytic portal, select settings and scroll down to Webhooks.
Step 2: Click the ‘New Endpoint’ button on the top right.
Step 3: Add a description for your webhook.
We recommend something simple and intuitive. For example: Lead Capture 2.0 to Hubspot webhook, or Lead Capture 2.0 to Pipedrive webhook.
Step 4: Copy/paste the end point URL for your webhook. This end point URL will be a URL you will get from the software you are sending your information to.
|
TOOL TIPS Guide on where to find your Pipedive end point URL Guide on where to find your Hubspot end point URL (second tab: endpoints) Guide on where to find your Salesforce end point URL |
Step 5: Choose the types of webhooks you would like to set up. To do this, select the radio button next to the ‘Event’.
NOTE: As a best practice we recommend using multiple endpoints for each event.
| Webhook Events & Which Ones to Use Our webhook event naming structure is formatting as such: product.entity or object.action Example: Capture.Session.Created Consider this when choosing which webhook to use. |
Event Overview
The webhook events that are currently available and those that are coming soon are as follows:
| Event | Definition |
| capture.Session.Created |
This is triggered when a new session starts. A new session is a unique visit of a user. NOTE: For Lead Capture this is triggered when a campaign URL is opened and a new user session is started. If Lead Capture is embedded to a landing page it is triggered when the landing page is opened. |
| capture.Session.Updated | This is when a Lead Capture session is updated and all of the required information in the chat is collected. NOTE: This is updated only after all of the information is collected and the AI design starts. |
| platform.conversation.created | This is relevant to the conversation feature. More information will be added down the road. |
| platform.conversation.message.created | This is relevant to the conversation feature. More information will be added down the road. |
| platform.conversation.message.deleted | This is relevant to the conversation feature. More information will be added down the road. |
| platform.conversation.message.updated | This is relevant to the conversation feature. More information will be added down the road. |
| platform.conversation.updated | This is relevant to the conversation feature. More information will be added down the road. |
| platform.Customer.Created | This is when a customer is created by using any of our products. In Embed it’s triggered when an AI design is created. In LITE+ this is when a homeowners’ details are manually entered. In Lead Capture this is when ALL of the questions are answered. |
| platform.Customer.Updated | This is when a homeowners’ information is updated manually within LITE+. |
| platform.design.created |
This is triggered when an AI design is finished within any of our products.
|
| platform.design.updated | This is triggered when an AI design is updated within any of our products (example: in Lead Capture this could be when a homeowner adds or removes panels, in our Embed/Design tool this could be when a user adjusts setbacks, adds and removes obstacles, etc. |
|
platform.file.created |
This is triggered when a file is uploaded by an Aerialytic user or by a homeowner themselves (example: when a user uploads a photo of a homeowners’ utility bill, when a user uploads permit paperwork , etc.). |
| platform.file.deleted | This is triggered when a file is deleted by an Aerialytic user or by a homeowner themselves. |
| platform.file.updated | This is triggered when a file is updated by an Aerialytic user or by a homeowner themselves. |
| platform.utility-profile.created | This is triggered when utility information is entered. NOTE: For Lead Capture this is captured after all of the required questions in the chat are answered as the API call happens at the end. |
| platform.utility-profile.created | This is triggered when utility information is updated in LITE+. |
A sample of the object types that can be mapped for each webhook are listed below:
Step 6: If you would like to add a verification secret for extra security, go ahead and do this. This is not mandatory, and if left empty, a secret will be automatically generated.
Step 7: Toggle on the ‘enable’ toggle, and click Create.
Once created, we always recommend running 2-3 tests to ensure important data is synchronizing with your preferred system.