Set up global parameters

You can send additional information from the SDK with each session and event by registering global callback and partner parameters.

Global callback parameters

If you register a callback URL in the Adjust dashboard, Adjust sends a GET request to your callback URL when the SDK records a session or event.

You can configure global callback parameters to your servers. Once you configure parameters, the SDK appends them to your callback URL. You can use this information to analyze your users’ in-app behavior with your BI system.

Add callback parameters

function addGlobalCallbackParameters(params: Array<GlobalParams>): void;

Add callback parameters to your sessions and events by calling the addGlobalCallbackParameters method with an array of string key-value pair objects. You can add as many objects to this array as you require.

1
Adjust.addGlobalCallbackParameters([
2
   { key: "key1", value: "value1" },
3
   { key: "key2", value: "value2" },
4
]);

For the above example, the callback URL looks like this:

https://www.mydomain.com/callback?key1=value1&key2=value2

Remove callback parameters

function removeGlobalCallbackParameter(key: string): void;

You can remove global callback parameters if they’re no longer required. To do this, pass the parameter key to the removeGlobalCallbackParameter method.

1
Adjust.removeGlobalCallbackParameter("key1");

Clear all callback parameters

1
function clearGlobalCallbackParameters(): void;

You can remove all global callback parameters if they’re no longer required. To do this, call the clearGlobalCallbackParameters method.

1
Adjust.clearGlobalCallbackParameters();

Global partner parameters

You can send extra information to your network partners by adding partner parameters to each session and event the Adjust SDK records.

Adjust sends partner parameters to external partners you set up. This information is useful for more granular analysis and retargeting purposes. Adjust’s servers forward these parameters once you’ve set them up and enabled them for a partner.

Add partner parameters

function addGlobalPartnerParameters(params: Array<GlobalParams>): void;

Add partner parameters to your sessions and events by calling the addGlobalPartnerParameters method with an array of string key-value pair objects. You can add as many objects to this array as you require.

1
Adjust.addGlobalPartnerParameters([
2
   { key: "key1", value: "value1" },
3
   { key: "key2", value: "value2" },
4
]);

Remove partner parameters

function removeGlobalPartnerParameter(key: string): void;

You can remove global partner parameters if they’re no longer required. To do this, pass the parameter key to the removeGlobalPartnerParameter method.

1
Adjust.removeGlobalPartnerParameter("key1");

Clear all partner parameters

function clearGlobalPartnerParameters(): void;

You can remove all global partner parameters if they’re no longer required. To do this, call the clearGlobalPartnerParameters method.

1
Adjust.clearGlobalPartnerParameters();