Set up callbacks

Set up callbacks to trigger functions when the SDK sends information to Adjust. You can set up callbacks for sessions and events.

Session callbacks

Set up session callbacks to trigger functions when the SDK sends session information. You can create success callbacks and failure callbacks. Success callbacks trigger when the SDK sends information to Adjust’s servers. Failure callbacks trigger when the SDK encounters a problem while sending the information.

Session callbacks have access to a response data object. You can use its properties in your callback function.

Property	Data type	Description
`Message`	`string`	The message from the server or the error logged by the SDK.
`Timestamp`	`string`	The timestamp from Adjust’s servers.
`Adid`	`string`	A unique device identifier provided by Adjust.
`JsonResponse`	`object<string, object>`	The JSON object with the response from the server.
`WillRetry`	`boolean`	Indicates whether there will be an attempt to resend a failed package.

Success callbacks

setSessionTrackingSucceededCallbackListener(
   sessionTrackingSucceededCallback: (session: AdjustSessionSuccess) => void
)

Set up success callbacks to trigger functions when the SDK records a session.

1
var adjustConfig = new AdjustConfig(appToken, environment);
2

3
adjustConfig.setSessionTrackingSucceededCallbackListener(
4
   function (sessionSuccess) {
5
      // Printing all session success properties.
6
      console.log("Session tracking succeeded!");
7
      console.log(sessionSuccess.message);
8
      console.log(sessionSuccess.timestamp);
9
      console.log(sessionSuccess.adid);
10
      console.log(sessionSuccess.jsonResponse);
11
   },
12
);
13

14
Adjust.create(adjustConfig);

Example

This example shows how to register a sessionTrackingSucceededCallback that prints the timestamp at which the SDK sent the session data to Adjust.

1
var adjustConfig = new AdjustConfig(appToken, environment);
2

3
adjustConfig.setSessionTrackingSucceededCallbackListener(
4
   function (sessionSuccess) {
5
      console.log(`Session recorded at ${sessionSuccess.timestamp}`);
6
   },
7
);
8

9
Adjust.create(adjustConfig);

Failure callbacks

setSessionTrackingFailedCallbackListener(sessionTrackingFailedCallback: (session: AdjustSessionFailure) => void)

Set up failure callbacks to trigger functions when the SDK fails to record a session.

1
var adjustConfig = new AdjustConfig(appToken, environment);
2

3
adjustConfig.setSessionTrackingFailedCallbackListener(
4
   function (sessionFailure) {
5
      // Printing all session failure properties.
6
      console.log("Session tracking failed!");
7
      console.log(sessionFailure.message);
8
      console.log(sessionFailure.timestamp);
9
      console.log(sessionFailure.adid);
10
      console.log(sessionFailure.willRetry);
11
      console.log(sessionFailure.jsonResponse);
12
   },
13
);
14

15
Adjust.create(adjustConfig);

Example

This example shows how to register a sessionTrackingFailedCallback that prints the reason the SDK failed to send the session data.

1
var adjustConfig = new AdjustConfig(appToken, environment);
2

3
adjustConfig.setSessionTrackingFailedCallbackListener(
4
   function (sessionFailure) {
5
      console.log(
6
         `SDK failed to record session due to ${sessionFailure.message}`,
7
      );
8
   },
9
);
10

11
Adjust.create(adjustConfig);

Event callbacks

Set up event callbacks to trigger functions when the SDK sends event information. You can create success callbacks and failure callbacks. Success callbacks trigger when the SDK sends information to Adjust’s servers. Failure callbacks trigger when the SDK encounters a problem while sending the information.

Event callbacks have access to a response data object. You can use its properties in your callback function.

Property	Data type	Description
`Message`	`string`	The message from the server or the error logged by the SDK.
`Timestamp`	`string`	The timestamp from Adjust’s servers.
`Adid`	`string`	A unique device identifier provided by Adjust.
`JsonResponse`	`object<string, object>`	The JSON object with the response from the server.
`EventToken`	`string`	The event token
`CallbackId`	`string`	The custom callback ID set on the event object
`WillRetry`	`boolean`	Indicates whether there will be an attempt to resend a failed package.

Success callbacks

setEventTrackingSucceededCallbackListener(eventTrackingSucceededCallback: (event: AdjustEventSuccess) => void)

Set up success callbacks to trigger functions when the SDK records an event.

1
var adjustConfig = new AdjustConfig(appToken, environment);
2

3
adjustConfig.setEventTrackingSucceededCallbackListener(function (eventSuccess) {
4
   // Printing all event success properties.
5
   console.log("Event tracking succeeded!");
6
   console.log(eventSuccess.message);
7
   console.log(eventSuccess.timestamp);
8
   console.log(eventSuccess.eventToken);
9
   console.log(eventSuccess.callbackId);
10
   console.log(eventSuccess.adid);
11
   console.log(eventSuccess.jsonResponse);
12
});
13

14
Adjust.create(adjustConfig);

Example

This example shows how to register a eventTrackingSucceededCallback that prints the timestamp at which the SDK sent the event data to Adjust.

1
var adjustConfig = new AdjustConfig(appToken, environment);
2

3
adjustConfig.setEventTrackingSucceededCallbackListener(function (eventSuccess) {
4
   console.log(`Event recorded at ${eventSuccess.timestamp}`);
5
});
6

7
Adjust.create(adjustConfig);

Failure callbacks

setEventTrackingFailedCallbackListener(eventTrackingFailedCallback: (event: AdjustEventFailure) => void)

Set up failure callbacks to trigger functions when the SDK fails to record an event.

1
var adjustConfig = new AdjustConfig(appToken, environment);
2

3
adjustConfig.setEventTrackingFailedCallbackListener(function (eventFailure) {
4
   // Printing all event failure properties.
5
   console.log("Event tracking failed!");
6
   console.log(eventFailure.message);
7
   console.log(eventFailure.timestamp);
8
   console.log(eventFailure.eventToken);
9
   console.log(eventFailure.callbackId);
10
   console.log(eventFailure.adid);
11
   console.log(eventFailure.willRetry);
12
   console.log(eventFailure.jsonResponse);
13
});
14

15
Adjust.create(adjustConfig);

Example

This example shows how to register a eventFailureCallback that prints the reason the SDK failed to send the event data.

1
var adjustConfig = new AdjustConfig(appToken, environment);
2

3
adjustConfig.setEventTrackingFailedCallbackListener(function (eventFailure) {
4
   console.log(`SDK failed to record event due to ${eventFailure.message}`);
5
});
6

7
Adjust.create(adjustConfig);