This guide describes how a postback can be sent from an advertiser/website to your Trackdesk system.
To send a postback for a conversion, you can use either GET or POST methods. Details on each method are provided below.
GET postback
GET postback
Fixed amount
To send a GET postback for an offer with a fixed amount, use the following postback to create a conversion:
https://YOUR_TENANT_ID.trackdesk.com/tracking/conversion/v1?conversionTypeCode=SELECTED_CONVERSION_TYPE&cid=OUR_CID
Replace YOUR_TENANT_ID with your actual tenant ID.
Replace SELECTED_CONVERSION_TYPE with the conversion type that should be created via postback (e.g. sale).
Replace OUR_CID with the Trackdesk's CID.
Revenue share
To use revenue share for an offer with a dynamic amount, you also need to provide the amount of revenue when creating the conversion. The amount is used in the system to calculate the commission of the network and affiliate.
Here is the GET postback to create a conversion for a revenue share scenario:
https://YOUR_TENANT_ID.trackdesk.com/tracking/conversion/v1?conversionTypeCode=SELECTED_CONVERSION_TYPE&cid=OUR_CID&amount.value=AMOUNT_PLACEHOLDER
Replace YOUR_TENANT_ID with your actual tenant ID.
Replace SELECTED_CONVERSION_TYPE with the conversion type that should be created via postback (e.g. sale).
Replace OUR_CID with the Trackdesk's CID.
Replace AMOUNT_PLACEHOLDER with the amount you want to prorate to the system to calculate the commission of the network and affiliate.
OPTIONAL: Adding extra parameters to GET postback
Up to 9 parameters for additional information can be added with a conversion. To add extra parameters to the GET postback, use the formats below.
A builder-like tool can be found here in the API documentation, allowing you to build the postback link - LINK
Extra parameters
Adv S1-Adv S5: General parameters for any information. There are a total of 5 of these parameters. Use the following format to add these parameters to the postback (example for Adv S1 parameter shown)
customParams.advS1=VALUE
Customer ID: General parameter for any information. Use the following format to add this parameter to the postback
customerId=VALUE
External ID: Parameter used for deduplication. This parameter can be present only once on the platform, generally an Order ID or other internal ID uniquely identify transaction is used. Use the following format to add this parameter to the postback
externalId=VALUE
Currency: Parameter used to specify the currency for the conversion. This parameter can be used only for cases with revenue share. Use the following format to add this parameter to the postback
currency.code=VALUE
Where VALUE is currency code in ISO 4217 format (e.g. USD, EUR or GBP)
Status: Parameter used to specify the conversion status that the conversion will be created with. Use the following format to add this parameter to the postback
status=VALUE
Refer to the API documentation for all allowed options - LINK (e.g. CONVERSION_STATUS_APPROVED, CONVERSION_STATUS_PENDING or other mentioned on the link)
POST postback
POST postback
Fixed amount
To send a POST postback for an offer with a fixed amount, use the following postback to create a conversion:
Endpoint:
https://YOUR_TENANT_ID.trackdesk.com/tracking/conversion/v1
Payload:
{
"conversionTypeCode": "SELECTED_CONVERSION_TYPE",
"cid": "OUR_CID"
}
Replace YOUR_TENANT_ID with your actual tenant ID.
Replace SELECTED_CONVERSION_TYPE with the conversion type that should be created via postback (e.g. sale).
Replace OUR_CID with the Trackdesk's CID.
Revenue share
To use revenue share for an offer with a dynamic amount, you also need to provide the amount of revenue when creating the conversion. The amount is used in the system to calculate the commission of the network and affiliate.
Here is the POST postback to create a conversion for a revenue share scenario:
Endpoint:
https://YOUR_TENANT_ID.trackdesk.com/tracking/conversion/v1
Payload:
{
"conversionTypeCode": "SELECTED_CONVERSION_TYPE",
"cid": "OUR_CID",
"amount": {
"value": "AMOUNT_PLACEHOLDER"
}
}
Replace YOUR_TENANT_ID with your actual tenant ID.
Replace SELECTED_CONVERSION_TYPE with the conversion type that should be created via postback (e.g. sale).
Replace OUR_CID with the Trackdesk's CID.
Replace AMOUNT_PLACEHOLDER with the amount you want to prorate to the system to calculate the commission of the network and affiliate.
OPTIONAL: Adding extra parameters to POST postback
Up to 9 parameters for additional information can be added with a conversion. To add extra parameters to the POST postback, include them in the payload as shown below.
A builder-like tool can be found here in the API documentation, allowing you to build the postback link - LINK
Extra parameters
Adv S1-Adv S5: General parameters for any information. There are a total of 5 of these parameters. Use the following format to add these parameters to the postback (example for Adv S1 parameter shown)
"customParams": {
"advS1": "VALUE"
}
To use more Adv S parameters following format is used"customParams": {
"advS1": "VALUE",
"advS5": "VALUE"
}Customer ID: General parameter for any information. Use the following format to add this parameter to the postback
"customerId": "VALUE"
External ID: Parameter used for deduplication. This parameter can be present only once on the platform, generally an Order ID or other internal ID uniquely identify transaction is used. Use the following format to add this parameter to the postback
"externalId": "VALUE"
Currency: Parameter used to specify the currency for the conversion. This parameter can be used only for cases with revenue share. Use the following format to add this parameter to the postback
"currency": {
"code": "VALUE"
}Where VALUE is currency code in ISO 4217 format (e.g. USD, EUR or GBP)
Status: Parameter used to specify the conversion status that the conversion will be created with. Use the following format to add this parameter to the postback
"status": "VALUE"
Refer to the API documentation for all allowed options - LINK (e.g. CONVERSION_STATUS_APPROVED, CONVERSION_STATUS_PENDING or other mentioned on the link)