
AnyTrack already supports a large variety of integrations that you can find in the Integration Catalog. And while we try to integrate new apps on a regular basis, you might need to create a custom integration. For that purpose, we enable you to create a custom integration from the catalog.
Prerequisites
- Your platform should be able to fire a webhook (GET or POST)
- You must pass the AnyTrack clickId to your cart, product link, or form (for CRMs)
- You should use the standard tracking parameters provided by AnyTrack
Create a Custom Integration
- Navigate to the integration catalog and search for the Custom Integration
- Set the name of your shop, or app.
- Set the integration's login page (optional)
- Click on create.
Generate your Webhook template
The next step allow to define the webhook template (also called the Postback URL), which will carry standard parameters and placeholders.
This step will ask you for the placeholders of your postback URL, for example {sub1}
for the click_id
.
Only The click_ id
and the conversion value placeholders are required.
π If you donβt know the right values for your integration you can ask your affiliate manager or put some default values in the meantime. You will be able to replace them manually after generating the postback URL.
In the example π you can see how we are adding the placeholders form the Hasoffers platform.
Conversion Funnel Logic
Because not all integrations send a conversion type parameter in the Postback, we apply a conversion logic based on the values sent in the conversion.
- A conversion recorded with 0 commission value will trigger a
Lead
. - Conversions recorded with a commission > 0 will trigger a
Purchase
conversion.
You can always use the event_name
parameter and provide the exact event name you want to use instead. For more details, see the list supported parameters below.
Supported Parameters
In addition to the placeholders requested on the second step, the Postback URL supports additional parameters. Here is a list of all the supported parameters:
Parameter Name | Type | Example | Requirements |
click_id | string | MAbadl0fpiROtrJ5N2GeEnE |
Required |
commission | number | 4.99 |
|
currency | string | EUR |
3 letters currency code. Default to the property currency. |
transaction_id | string | 10492A |
A unique transaction id for deduplication |
brand_name | string | Apple Inc. |
The offer name or product name.
|
event_name | string | CompleteRegistration |
The event name to use
|
* All parameters can be sent via GET or POST requests and can be placed either on the URL or on the request body.
Matching Parameters
The following parameters are also supported for better matching and attribution. Those values will forward for Facebook and other pixels automatically in the compatible format.
Parameter name | Type | Example | Notes |
string | jsmith@example.com |
||
first_name | string | John |
|
last_name | string | Smith |
|
name | string | John Smith |
Using this field will automatically fill first and last name fields |
phone | string | +1 (650) 555 4444 |
Including country code and area code |
birthdate | string | May 26, 1991 or 1991-05-26 |
|
city | string | Menlo Park |
|
state | string | CA |
Two-letter state or province code |
zipcode | number | 94025 |
Zip or Postal Code |
country | string | US or United States |
* There is NO need to use any hashing on the data. AnyTrack automatically formats and hashes the data for you when sending it to the pixels.
Postback URL Example
Here is a complete example of a postback URL template we prepared using some of the parameters above:
https://t1.anytrack.io/GqxV3nTo/collect/custom-newtest?click_id={click_id}&commission={commission}¤cy={currency}&transaction_id={transaction_id}&brand_name={brand_name}&event_name=CompleteRegistration&email={email}&name={name}
Here is an example of the template URL will all the parameters values:
https://t1.anytrack.io/GqxV3nTo/collect/custom-newtest?click_id=CAxaduSFl0fpiROSdRkptrJ5REfN2GeEnE&commission=4.99¤cy=USD&transaction_id=10492A&brand_name=Apple%20Inc&event_name=CompleteRegistration&email=jsmith%40example.com&name=John%20Smith
Don't be afraid to enrich your Postback URL
In the tracking world data is power πͺ
Feel free to add more parameters to your Postback URL and pass more information about the event.
For example, the next postback URL has only the parameter of the click ID:
https://t1.anytrack.io/useridxxx/collect/impact?click_id={click_id}
You can insert additional information like commission and currency:
https://t1.anytrack.io/useridxxx/collect/impact?click_id={click_id}&commission={commission}¤cy={currency}
Remember: commission={commission}
This part stays as the name of the parameter. ( AnyTrack supplies this parameter)
This part will be substituted with the real value. ( You have to ask it from the platform that you want to integrate)
They are even Postback URLs like this one, which can give us the whole picture of the event:
https://t1.anytrack.io/useridxxx/collect/impact?ActionTrackerName={ActionTrackerName}&CampaignId={CampaignId}&CampaignName={CampaignName}&MediaPartnerId={MediaPartnerId}&MediaPartnerName={MediaPartnerName}&SubId1={SubId1}&SubId2={SubId2}&SubId3={SubId3}&AdId={AdId}&ActionTrackerId={ActionTrackerId}&ActionId={ActionId}&commission={commission}¤cy={currency}&Payout={Payout}&EventDate={EventDate}&Status={Status}&StatusDetail={StatusDetail}&LandingPageUrl={LandingPageUrl}&SharedId={SharedId}&PromoCode={PromoCode}&RefCustomerCountry={RefCustomerCountry}
π‘ Good to know:
- Empty parameters won't cause any damage
- Parameters with values will be displayed and can be used.
Checking parameters on the event log
Inside the integration you will find the event log section:
Clicking on it will let you check your event payloads and review all the parameters :
"query": {
"affiliate_id": "4479"
"payout": "4.48500"
"commission": 500,
"aff_click_id": "ej2kaIZSEV1rhNu8ohhqtt",
"advertiser_id": "2",
"offer_url_id": "51",
"goal_id": "5",
"datetime": "2020-05-19 12:46:16",
"offer_file_id": "0",
"currency": "USD",
"offer_ref": "PRO",
"aff_sub5": "ej2kaIZSEV1rhNu8ohhqtt",
"advertiser_ref": null,
"transaction_id": "10219dbfbe3c8802f63db008acd29c",
"device_id": "{device_id}",
"ip": "35.161.196.166",
"offer_id": "2",
"hasoffers": "tradingview",
"session_ip": "92.170.247.132",
"sale_amount": null
}
Generating a Click ID
Learn more about generating click ids on offer links on your website, hidden form inputs, or programmatically via AnyTrack TAG snippet.
If you just want to store the current client id without generating new events you can always generate an atclid
and use it as a Click ID.
Comments
0 comments
Please sign in to leave a comment.