Standard API Integration

Integration Overview

Hatch’s standard API allows your business to pull lead information into Hatch from any source that can support a POST API endpoint. 

Through our integration, leads from the API endpoint are instantly pulled into Hatch and put into a Hatch campaign using text, email and voicemail communication. 

Here’s how it works:

First, a contact fills out a lead form for your business.

Once the form is submitted, Hatch receives that lead information and puts the contact into a campaign within Hatch. The contact receives a message that looks like this: 

Here you can see the message Mary was sent after she filled out the lead form. 

When the contact responds to the message, your Hatch user will be able to respond from their Board. 

Here you can see the message Mary sent popped up on the Hatch Board. 

How to Set-up

Level of Difficulty: Medium 

To set up this integration, you will need someone on your development team to help.

1. Confirm with your development team that they can follow the specifications listed below. Just send them this article!
2. Talk to your Customer Success Manager or Contact Support and collect your Hatch Department ID and your unique API Key. Your development team will need this information to set up the integration. 
3. Have your development team use the following information to create a POST to our Hatch Endpoint. Make sure to replace the placeholders for Department ID and Hatch API Key.

   Hatch Webhook POST Endpoint 

   https://prod.usehatchapp.com/api/webhooks/[DEPT_ID_PROVIDED]/newlead

   **The following "Headers" and "Body" information is not to be placed in your website**

    Headers

   X-API-KEY: [CLIENT_API_KEY_PROVIDED]
   
   Content-Type: application/json

    Body

   {
   //required
   "firstName": "John", 
   
   //required
   "lastName": "Doe", 
   
   //phone or email required, at least one
   "phoneNumber": "8048675309", 
   
   //phone or email required, at least one
   "email": "testjohndoe@test.com", 
   
   //required
   "source": "lead_source_name", 
   
   //optional
   "status": "my_lead_status", 
   
   //optional
   "id": "123098456", 
   
   //optional
   "contactID": "1001123123900", 
   
   //optional, must follow format*: "externalCreatedAtFmts" 
   "createdAt": "2020-01-02T15:04:05-0700", "2006-01-02T15:04:05-0700"
   
   //optional, must follow format*: "externalCreatedAtFmts" 
   "updatedAt": "2020-05-01T17:04:07-0800", 
    
   //any other JSON fields including nested arrays of json fields can be added to the root. It will be flattened upon consumption
   }
   

   *DateTime format explanation

4. Once your team has set up the connection, the lead will automatically be sent to Hatch when a form is submitted. 
5. You can test this by filling out a lead form where the API has been hooked up, and then confirming that the lead is in Hatch in the Contacts Page.
6. Now, we will want to set up a Campaign in Hatch to automatically drop those leads into. Work with your Customer Success Manager to decide what Campaign you want to use.

FAQ

Why is instant lead engagement important?

Speed to Lead is extremely important when it comes to new leads.  The first company to get to a new lead, wins!  

Who is this integration for?

This integration is available to Hatch Users. There is no additional fee to turn the integration on, we’ll just need to work with you to get all the necessary information to get started. 

How long does it take to get set up? 

Once your team has placed the above information in your web code, the integration is ready to go! Just make sure to talk to your Customer Success Manager about what campaign you want to put those incoming leads into. 

What other Lead Source or Speed to Lead integrations do you offer? 

We offer lead engagement integrations with HomeAdvisor, Modernize, Quinstreet, and more. To see the full list, check out our website.