Callback structure

To set up a callback, you need to specify:

  • The correct callback parameter for your callback type.
  • The server endpoint URL where you want to receive data.
  • Adjust placeholders for the data points that you want to record.
  • Macros for the data points that you want to share.
  • Partner parameters (if applicable) to receive information about in-app events or sessions from your clients.
Note:
When you integrate with Campaign Lab, we ask you to share your callback URLs and macros. We append your callback URLs (except for event callbacks) and macros when your client generates the link URL.
For event callbacks, you need to append the event token to the event callback parameter. In this case, we recommend that you use the Encoding tool.
If you have any questions, contact integration@adjust.com.

Callback parameters

Callback URL/endpoint

Adjust placeholders

Macros

Partner parameters

OPTIONAL

Example

Click link URL with campaign structure parameters and device identifiers, and install and event callbacks

Encoded URLAlways encode the callback
Unencoded URLDo not use as is
https://app.adjust.com/abc1234?campaign=new-campaign&adgroup={sub_id}&creative={crt_id}&idfa={network_idfa_macro}&gps_adid={network_gaid_macro}&install_callback=http%3A%2F%2Fmynetworkserver.com%2Fcallback%3Fcountry%3D%7Bcountry%7D%26click_id%3D{click_id}&event_callback_r8oaj2=http%3A%2F%2Fmynetworkserver.com%2Fcallback%3Fcountry%3D%7Bcountry%7D%26click_id%3D{click_id}%26event%3Dregister%26partner_parameter%3D%7Bpartner_parameters%7D

In this example, we explain the structure of a final unencoded URL. Ensure that you always encode your URL before you go live with your campaign.

  • Adjust link URL with link token shared by your client - https://app.adjust.com/abc1234
  • Campaign structure parameters - campaign, adgroup, creative
  • Partner macros - new-campaign, {sub_id}, {crt_id}
  • Advertising identifiers - idfa, gps_adid
  • Partner macros for advertising ID - {network_idfa_macro}, {network_gaid_macro}
  • Install callback - install_callback=http://mynetworkserver.com/callback?country={country}&click_id={click_id}
    • Callback parameter - install_callback
    • Callback URL/endpoint - http://mynetworkserver.com
    • Adjust placeholder (Adjust servers populate data) - {country}
    • Network's macro (Network servers populate data) - {click_id}
  • Event callback - event_callback_r8oaj2=http://mynetworkserver.com/callback?country={country}&click_id={click_id}&event=register
    • Callback parameter - event_callback
    • Event token (shared by client and appended to event callback parameter) - r8oaj2
    • Hardcoded value corresponding to event token - event=register
  • Partner parameters placeholder - {partner_parameters}