This section describes the APIs used to configure and manage an Embedded Journey instance at the user level.
End user APIs are generally consumed by the Embedded Journeys UI after a short-lived userOneTimeToken is generated for the user. Partners can also use these APIs if they are building a custom interface for Embedded Journey setup.
Using these APIs, a user can:
- Retrieve Embedded Journey instance details
- Create or test connections required by the Journey
- Get a connection redirect URL
- Get all available connections for an app
- Link an existing connection to an Embedded Journey instance
- Update config data
- Fetch picklist data and extended schema
- Get app configuration details
What can end users do?
| Area | What the user can do |
|---|---|
| Embedded Journey Instance | Retrieve a user-specific Embedded Journey instance. |
| Connection | Create, test, retrieve, or link app connections required by the Embedded Journey instance and list connections using the app alias. |
| Config Data | Update configurable values required for Journey execution. |
| Picklist | Fetch dynamic dropdown or list values during configuration. |
| Extended Schema | Retrieve dynamic field schema based on app, action, trigger, input, or connection. |
| App Configuration | Retrieve app-level configuration details using the app alias. |
Typical end user flow
- Receive a short-lived one-time token.
- Retrieve the Embedded Journey instance details.
- Configure or link the required app connections.
- Test the configured connections, where required.
- Fetch picklist data, extended schema using app configuration details if required.
- Update the required config data.
- Complete the setup so the Embedded Journey instance is ready to run.
- Start the instance.
End-user authentication
End User APIs use the short-lived user one-time token in the request header:
Authorization: api-key <userOneTimeToken>The userOneTimeToken is valid for one hour from the time it is generated.
Base path
The basePath represents the environment-specific base URL used to make API requests.
{basePath}During integration setup, Quickwork will share the base path and the process to generate a user one-time token for the relevant environment. These values must be configured before API requests can be tested.