Campaign Webhook

Scope

The campaign web-hook allows the user to post data to a Convertr campaign using a campaign API key to authenticate the request.

Setup Process

1. Go to ‘Setup’ under the ‘Admin’ tab on the Convertr campaign overview dashboard

2. Once you are on the setup page, scroll down to the ‘Campaign API’ section. This is where you will see the ‘Campaign API Key’. This will present a code that will function as the access token for the duration of the campaign you have selected.

Using the Campaign API Key

Form Fields Endpoint

This API call will supply an array of forms along with the form fields on the campaign.

Example Form Fields Request

https://[enterprise].cvtr.io/webhook/campaign/[CampaignID]/global-form/fields?apikey=[campaignAPIkey]

Example Form Fields Response

[
    {
        "formName": "Form Fields Endpoint",
        "formId": 75,
        "fields": [
            "form[firstName]",
            "form[lastName]",
            "form[email]",
            "form[telephone]"
        ]
    }
]

Campaign Links Endpoint

This API call will return an array of available links for the given campaign. The Link ID is optional but it does provide insight into which channel a lead entered the Convertr Platform.

Example Campaign Links Request

https://[enterprise].cvtr.io/webhook/campaign/[campaignID]/links?apikey=[campaignAPIkey]

Example Campaign Links Response

[
    {
        "id": 135,
        "name": "Campaign Links Endpoint",
        "channel": "Email",
        "destination": "https://Campaign-Links-Endpoint.cvtr.io/lp/Campaign-Links-Endpoint"
    }
]

Campaign Lead Post Endpoint

The API call will allow you to post leads to the given campaign.

Example Lead Post Request

https://[enterprise].cvtr.io/webhook/campaign/[CampaignID]/global-form/[GlobalFormId]/leads?apikey=[campaignAPIkey]&campaignLinkId=[linkid]

Example Lead Post Request with Publisher ID

Additionally if you would like to pass the publisher id with the lead you can post as below (the publisher ID can be obtained from the platform by going to the publisher section - https://[enterprise].cvtr.io/publisher/list).

https://[enterprise].cvtr.io/webhook/campaign/[CampaignID]/global-form/[GlobalFormId]/leads?apikey=[campaignAPIkey]&campaignLinkId=[linkid]&publisherId=[publisherId]

Example Lead Post Payload (unencoded)

form[firstName]=Joe&form[lastName]=Bloggs&form[email]=tech@convertr.io&form[telephone]=02036177659

Example Lead Post Response

{
    "code": 201,
    "message": "Lead was created successfully",
    "data": 55907
}

Error Responses