What is Zapier?
Zapier is a no-code automation platform that connects apps and services to work together seamlessly. It allows users to create automated workflows, called Zaps, which link two or more applications so that when a trigger event happens in one app, Zapier automatically performs predefined actions in others.
It is especially useful for linking different tech solutions that cannot connect directly. In the case of Convertr, Zapier is able to use its webhook solution to submit data into the Convertr platform through our publisher and campaign APIs.
This document will talk about how to submit a lead to Convertr using the Publisher API.
Prerequisites
- Please refer to Sending leads to the Convertr Platform (Publisher API) - V2.4 and ensure you have all credentials that are mentioned here.
- You will need to have your own Zapier account, or access to one. Convertr will not be able to provide access to Zapier.
- In Zapier, you will need to have a Zap that contains the information that you wish to pass into a Convertr campaign. See more on Zapier here.
Setup Process
For the Zapier process, we will only cover the implementation of the Convertr connection in a Zap. The trigger for a Zap will be dependent on how you receive data into Zapier.
In the example below, the Zap is being triggered by a webhook submission.
-
Within your Zap, you will need to create an authentication step in order to retrieve the access token needed to make requests. You can do this by adding a Webhook step to your actions:
-
As shown in the Publisher API document, you will need to select POST as your action event in the Setup pane on the right. In the Configure step, you will configure your authentication request:
URL: https://{enterprise}.cvtr.io/api/login
Payload Type: Form
Data; Username: {USERNAME}
Data; Password: {PASSWORD}
-
After this, click Continue. You can now test this step, and if successful you will receive an access token in your response.
-
Now, you will need to create a new Webhook step with POST action. This step will be used to submit data to a Convertr campaign.
-
In the Configure step, you will build a request based on the lead forms endpoint in the Publisher API. Most importantly, you will need to map your fields to the Convertr form you wish to submit to.
On the left hand side of the Data section, add the field names as they are in Convertr on the campaign you wish to send data to. On the right hand side, you can map the data that you are retrieving from previous Zapier steps.
To look at which fields are available in your Zap, use the + button within the field to search.
URL: https://{{enterprise}}.cvtr.io/api/v2.4/publisher/{{publisher_id}}/forms/{{form_id}}/campaign/{{campaign_id}}/leads
Payload Type: Form
-
You will also need to map the access token in the Headers section at the bottom of the side pane:
Field: Authorization
Value: Bearer {{select the access token from your previous step here}}
This will complete the implementation of the Publisher API. Click Continue and you can now test the step and confirm that data flows as expected to the correct place.