Please Note: This feature is currently being transitioned to an updated version. As we make this transition you may see multiple versions of the same document. Please use the relevant one depending on your requirements.

The Current Version of the document is at the top of the page and the Updated Version is at the bottom.

-------------------------------------------------------------------------------------

Current Version

-------------------------------------------------------------------------------------

Overview

If both you and your client are users of the Convertr platform, and you are sending leads directly into your client's instance, we have an integration that will simplify the delivery of your leads into their platform.

The Convertr Connect integration allows you to input your publisher API details as well as the details of the campaign your client has set up, and it will automatically pull through all of their form fields for you to then map onto your own. 

In addition, your client's instance will be able to communicate with your own - if any leads are marked as invalid or valid on their side, it will automatically update your own record of that lead, making this the easiest way to easily manage leads between yourself and the client.

Note: The Convertr Connect integration was previously called the Enterprise to Enterprise integration and provides the same functionality. 

Prerequisites

• You must have the subdomain of your client's instance (e.g if the client's Convertr url is {enterprise}.cvtr.io, then their subdomain is {enterprise})
• You will need publisher level access to your client's instance to retrieve the the API Key, Publisher ID and Campaign ID.

Retrieving Your API Key

1. In the receiving platform (your client's platform), select the appropriate campaign and select Tracking from the action buttons on the right.
   
   
   
   
2. This will open the Tracking Information module. Select the API Credentials tab.
   
   
   
   
3. Within this screen, retrieve your API Key, Publisher ID and Campaign ID. You will need to enter these details when you configure the Convertr Connect Integration in your platform campaign.
   
   

Setting up your Integration

1. On your enterprise, select your campaign and navigate to the Processr > Integration. Select Add Job, and choose Convertr Connect job. Clicking Save will then open the configuration window
   
   
   
   
2. Fill in all the prerequisite fields in the top section.
   
   
   
3. If these credentials are valid, then you will get a dropdown when selecting the form ID. You can then select the form you wish to use.
   
   
   The same will also occur for Link, but this is not a mandatory requirement and may not return anything if no links have been configured by your client.
   
   
4. When you select a form, the mapping section will populate with all fields that are available on that form.
   
   
   All that you will need to do is map your corresponding field from your own form on the right hand side.
   
   
   
5. Lastly, a button will have appeared at the top of the integration called Place Sync Tags.
   
   
   This enables your client's platform to provide feedback when they update the status of your leads.
   
   For example, if a lead is rejected as invalid once your client receives it, we will append this to the lead in your own system along with the reason:
   
   

There are 4 different triggers for these tags:

1. If your lead is valid in the client's platform, we will mark your lead as valid
2. If your lead is invalid in the client's platform, we will mark your lead as invalid
3. If your lead is cautioned in the client's platform, we will mark your lead as invalid
4.  If your lead is deleted in the client's platform, we will mark your lead as invalid

These statuses will update whenever the lead is updated in your client's platform, so it's possible a lead's status could change if they manually flag the lead.

Without these tags, this communication will not occur - the button will change to indicate if the tags have already been placed:

Once you are happy, click Save at the bottom to complete the integration configuration.

-------------------------------------------------------------------------------------

Updated Version

-------------------------------------------------------------------------------------

Overview

If both you and your client are users of the Convertr platform, and you are sending leads directly into your client's instance, we have an integration that will simplify the delivery of your leads into their platform.

The Convertr Connect integration allows you to input your publisher API details as well as the details of the campaign your client has set up, and it will automatically pull through all of their form fields for you to then map onto your own. 

In addition, your client's instance will be able to communicate with your own - if any leads are marked as invalid or valid on their side, it will automatically update your own record of that lead, making this the easiest way to easily manage leads between yourself and the client.

Note: The Convertr Connect integration was previously called the Enterprise to Enterprise integration and provides the same functionality. 

Prerequisites

• You must have the subdomain of your client's instance
  • (e.g if the client's Convertr url is {enterprise}.cvtr.io, then their subdomain is {enterprise})
• You will need publisher level access to your client's instance to retrieve the the API Key, Publisher ID and Campaign ID. 

Retrieving Your API Key

1. In the receiving platform (your client's platform), select the appropriate campaign and click Tracking from the action buttons on the right.
   
   
   
   
2. Select the API Credentials tab from within the Tracking Information modal.
   
   
   
   
3. Retrieve your API Key, Publisher ID and Campaign ID. You will need to enter these details when you configure the Convertr Connect Integration in your platform campaign.
   
   

Setting up your Integration

1. a. Navigate to the Processr and click on the Integrations tab. Click Add and select Convertr Connect from the dropdown, or start typing to find the job.

1. b If you are editing an existing Convertr Connect integration, click Configure beside the job in the Processr.

2. The first 5 boxes contain the prerequiste information:

Subdomain - This is the subdomain of the enterprise you are delivering to

API_Key - This is your publisher-specific key from the client's enterprise

Campaign ID - This is the unique ID given to the campaign you are delivering to

Publisher ID - This is your unique publisher ID on the client's enterprise

Global Form - This is the form you are sending your leads 

Please Note: As you enter details you will notice that subsequent boxes may be automatically populated.

3. The Link field is not mandatory, therefore you will only need to populate this if asked. As you enter your details above, the Mapping fields will automatically pull through from the Enterprise you are sending to on the left hand side. You will need to use the dropdowns on the right hand side to map the client's fields to your fields.

If you need to add additional fields, click Add. 

4. To place your Sync Tags, click Configure beside Convertr Connect and click Place Sync Tags.


This enables your client's platform to provide feedback when they update the status of your leads. For example, if a lead is rejected as invalid once your client receives it, we will append this to the lead in your own system along with the reason:

There are 4 different triggers for these tags:

1. If your lead is valid in the client's platform, we will mark your lead as valid
2. If your lead is invalid in the client's platform, we will mark your lead as invalid
3. If your lead is cautioned in the client's platform, we will mark your lead as invalid
4.  If your lead is deleted in the client's platform, we will mark your lead as invalid

These statuses will update whenever the lead is updated in your client's platform, so it's possible a lead's status could change if they manually flag the lead.

Once you are happy, click Save at the bottom to complete the integration configuration.