Skip to content

Enrich Journey Completion Token

Client SDK
Sub-journey
Legacy journey token behavior

This step applies to the legacy journey token returned upon successful SDK journey completion. The current SDK journey completion model is documented in Journey completion for SDK journeys. Disable Return journey token on completion under Identity Journeys > Journey settings if you want to stop returning the legacy journey token on completion.

Adds information to the legacy journey token created upon successful journey completion

Description

When the legacy journey token behavior is enabled, a successful SDK journey completion can return a journey token to the client application as a JWT. The client can then validate the token signature and extract the info contained within its claims. You can add custom claims to the token, where each claim value is evaluated at runtime. This can be used to return additional info in the legacy journey token upon completion.

Configuration

FieldDescription
JWT Token Enrichment ValuesA list of custom claims to add to the token. The name represents the claim ID and the expression yields the value for the generated claim at runtime.
Journey event data

This step can be configured to record step input and output data, or a custom payload, which is then surfaced in journey events in Journey Analytics for diagnostic purposes. For details, see Additional data reporting.

Note

A custom claim cannot use the same ID of one of the standard claims generated by Transmit:
jti, exp, aud, pid, did, sid, iat, ted, params, pvid

Example

Suppose transaction details are provided by the client when initiating a journey in a transactionDetails object. You can include them in the generated token in a claim named transaction_details configuring the following: