How do I get started with leads automation?

To enable integration of our system with your leads service, you'll need to do the following:

1. Ensure that you are set up as a creative / marketing representative, as only they may set up a webhook.
2. Go to the client portal for your company.
3. Click on the "Leads" link in the nav bar.
4. Look for the gray box in the middle right of the page.
5. Click the link to access your leads webhook form.

Each section of the form has its own description, which you should read carefully to be sure you understand how everything works. If you still have questions, please contact your marketing services rep for assistance.

What is a webhook?

A webhook is an event that triggers under certain conditions and that "hooks into" another application. The leads webhook triggers whenever a lead comes in for one of your assets or, if you have checked "RFI Enabled", your showcase. When it triggers, we send data to the endpoint that you specified with the expectation that it is prepared to receive the data and act on it in some manner.

How do I process the data sent by the webhook?

The data will be sent in a POST request. This is the same sort of request typically used in web forms, and you ought to be able to use the same sort of behind-the-scenes logic to process the data. If you are using a third-party service to process leads, they should be able to take care of processing for you. Otherwise, you will need to consult a web developer to build something that is capable of receiving the data we send and routing it where it needs to go.

How do I know what endpoint to enter?

Locating the correct endpoint is typically the most confusing part of the setup process, especially for those with limited programming knowledge who are uncertain of what they are looking for. Depending on the service that you use, your endpoint will differ, so you will have to familiarize yourself with the intricacies of your service in order to proceed. In general, the URL that we are after here is the one that processes form data—not the one where the form is presented. Most services will also provide a URL with a key that uniquely identifies your form. This may come in the form of a separate API key that needs to be passed along with your data, or it may be in the URL itself.

Certain common services are listed below, along with examples of the kinds of URLs that you should be looking for.

1. HubSpot: https://api.hsforms.com/submissions/v3/integration/submit/1234567/a45ge93-dr9w-2049-e43w-20di49w7mdi4
2. Marketo: https://app-cd34.marketo.com/index.php/YourForm/save
3. SalesForce: https://yourcompany.secure.force.com/harvestsync/services/apexrest/YourForm
4. Eloqua: https://s395810482.t.eloqua.com/r/w4?elqFormName=YourForm&elqSiteID=395810482

In addition to direct integrations using endpoints like those above, some clients host an endpoint on their own servers and route data from there. This is the most versatile way of handling data, as it gives you the freedom to connect with services however you like, but it does mean that you would need someone with programming knowledge to set up and maintain the endpoint.

The service I use requires a special submission format. How do I accommodate this requirement?

Our webhook will do a POST request with the specified request headers to your endpoint whenever a new lead comes in. If the service that you are using to manage your leads cannot handle a post directly, then you will need to create a URL of your own on your own servers to "catch" whatever data we throw your way and redirect it to that service in the proper format. That said, most major services can handle POST requests. It's just a matter of finding the material on how to hook everything up.

How can I change the name used for a particular field to the one used by our leads management service?

This is what the "Post Name" column is for. Checking a field means that it will be included in the POST request that we send. If no post name is specified, then we will use the default field name shown in this blank. If you need another name—say "email_address" instead of "email"—just enter this as the post name, and we will send users' emails under that name instead.

We need something that is not listed here. How do we get it?

Depending on what you are after, we may or may not be able to accommodate. Please contact your marketing services representative and let them know what you are looking for, and we will see what we can do.