STATEWIZE
Search…
SDK Integration
How to report events to STATEWIZE
Integrating with STATEWIZE is designed to be simple and quick;
- 1.
- 2.Download your journey integration map (available on the floating menu, on any journey page) 👀
4. Initialise the SDK:
1
import {StatewizeClient} from 'statewize-client-sdk';
2
3
const sdk = new StatewizeClient(procees.env.YOUR_TOKEN);
Copied!
5. Report events (see below)
Real-time monitoring & tracking
When your user starts a journey:
1
await sdk.startJourney({
2
journeySlug: 'your-journey-slug',
3
yourId: "Your ID used to track this journey",
4
yourUserId: "my-user-1234"
5
});
Copied!
Reporting an event (a step) of a journey:
1
const {eventTrackingId} = await sdk.reportEvent({
2
yourId: "Your Tracking ID",
3
type: "started",
4
slug: journeyMap.YOUR_STATE_NAME, // from step 3
5
yourUserId: 'your-user-1',
6
});
7
Copied!
Updating a previously-reported event (i.e new data available - or it's an asynchronous event which starts at one time and ends later, etc):
1
await sdk.reportEvent({
2
eventTrackingId,
3
type: "finisned",
4
slug: journeyMap.YOUR_STATE_NAME, // from step 3
5
yourUserId: 'your-user-1'
6
});
7
Copied!
Child events (which are occurring as part of a different event):
1
await sdk.reportEvent({
2
parentEventTrackingId: eventTrackingId,
3
type: "finisned",
4
slug: journeyMap.YOUR_STATE_NAME, // from step 3
5
yourUserId: 'your-user-1'
6
});
Copied!
Journey Ended
1
await sdk.endJourney({
2
yourId: execId,
3
status: 'complete'
4
});
Copied!
And that's it!
A few notes;
- 1.Reporting an event without starting a journey - is possible. If you do so - the relevant journey will be found, started, and then an event will be reported.
- 2.You don't have to split an event into
startedandfinished- you can report it asfinishedon the first call - it's all up to you, however you'd like the tracking to take place. - 3.STATEWIZE allows you to use your own ID by providing a
yourIdfield in various SDK methods. This can be helpful when you have a known ID which you'd like to maintain for subsequent journey tracking purposes, instead of persisting the ID returned from STATEWIZE. - 4.Environments - You can set your environment in the constructor of the
StatewizeClient, as well as on thestartJourneyevent. An environment can be any of the following: [development,testing,staging,production].
Last modified 3mo ago
Copy link
Contents
Real-time monitoring & tracking