Set Organization
Associates a user with an organization at the beginning of a journey.
Description
This step allows binding the journey to a specific B2B org context. Typically it is triggered early on in the B2B journey to ensure the rest of the journey continues within the context of a specific organization.
The organization domain must be available before initiating the step. For example, as a previous step, the user may select the organization they want to continue working with.
If the step is successfully completed, the journey will continue operating within the provided org context, for example, it will dynamically filter available authentication methods on the Login form or provide access to member management operations. The org context set by this step can be retrieved in the subsequent journey step using the @organizations.current() expressions, for example, @organizations.current().organization_id or @organizations.current().name. If the step fails, the journey proceeds to a failed branch (if one is specified); otherwise, the journey is aborted and an error is sent to the client.
Configuration
| Field | Description |
|---|---|
| Organization (domain) | Expression that yields the domain name that corresponds to an organization. |
| Error output variable | Name of the variable that stores any errors returned by step. |
| Failure behavior | Determines the behavior in case of failure, which either aborts the journey (default) or proceeds to a failure branch of the control flow. |
| Custom branches | Additional journey branches supported for this step. For each branch, you define a branch ID and display name to label it in the editor, and a schema for the input expected back from the client. Note: The schema is used by the code generator and for autocompleting journey expressions, and isn't expected to be used by the client dynamically. The client can select a branch by returning the branch ID when calling submitClientResponse(). |
| Branch output variable | Name of the variable used to store the data, which can be used in subsequent journey steps. |
| Cancel behavior | Determines the behavior of client cancellation, which either aborts the journey (default) or proceeds to a cancel branch of the control flow. |