# Journey Launcher
The Journey Launcher allows journeys to share a common start screen. When embedded in a client web page, the journey launcher allows the user to select from various journeys shown as tabs. The first step of each journey is shown whenever the corresponding journey tab is selected.
---
## HowTo: Create a Journey Launcher (for developers)
To set up a journey launcher, follow the steps below:
### 1. Get the Id for the Journey Launcher template
You need to have access to a Journey launcher template to create a Launcher Journey. To get the `templateId` of the launcher template, use the following request:
```bash
curl --location --request POST 'https://journey-config.sls.epilot.io/v1/journey/templates/search' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
"q": "(!(_exists_:tags)) OR !(tags:draft) OR (tags:launcher)"
}'
```
The response will return with a list of all launcher templates (ideally, only one). Take note of the `templateId` from `results[0].templateId` given it will be needed in the following steps.
### 2. Get the IDs for the Brand and Style
The journey launcher is a special type of journey that is created from a template. In addition to the journey template, the journey launcher also requires the following:
- Brand Id
- Style Id
To get the brand and style identifiers, use the following request:
```bash
curl --location --request GET 'https://design-builder-api.sls.epilot.io/v1/brands' \
--header 'Authorization: Bearer '
```
Take note of the `id` field from one of the `brands` in the response; that will be the brand Id.
To get the style Id, use the following request:
```bash
curl --location --request GET 'https://design-builder-api.sls.epilot.io/v1/designs' \
--header 'Authorization: Bearer '
```
Take note of the `id` field from one of the `designs` in the response; that will be the style Id. Also, ensure that the selected design has the same `brand_id` as the brand Id identified previously.
### 3. Create a launcher journey using the template ID
With the template ID from Step 1, create a launcher journey using the following request:
```bash
curl --location --request POST 'https://journey-config.sls.epilot.io/v1/journey/configuration' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "",
"organizationId": "",
"brandId": "",
"steps": [
{
"name": "Launcher step",
"schema": {
"type": "object",
"properties": {
"Launcher block": {
"type": "object"
}
}
},
"stepId": "New step",
"hideNextButton": true,
"uischema": {
"type": "MainContentCartLayout",
"options": {
"scale": 5
},
"elements": [
[
{
"type": "JourneyLauncherControl",
"options": {
"stickyOnMobile": false,
"stickyOnMobileIndex": 1,
"showPaper": true
},
"scope": "#/properties/Launcher block"
}
],
[],
[],
[]
]
}
}
],
"rules": [],
"logics": [],
"tags": [
"launcher"
],
"settings": {
"designId": "",
"templateId": "",
"description": "",
"safeModeAutomation": true,
"runtimeEntities": [
"OPPORTUNITY"
]
}
}'
```
The response object contains the journey Id for the newly created launcher journey. Take note of this journey Id, as it will be needed when linking journeys to this journey Id.
### 4. Get the journey Ids for the (child) journeys that will have to be linked
To search for a journey using the title of the journey, use the following request:
```bash
curl --location --request POST 'https://entity.sls.epilot.io/v1/entity/v1/entity:search' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
"q": "_schema:journey",
"fields": ["journey_id", "_title", "tags"],
"size": 25,
"sort": "_created_at:asc",
"from": 0,
"hydrate": true
}'
```
Do this and take note of the `journeyId` for each child journey that is to be linked to the launcher journey.
### 5. Linking Journeys to the Launcher Journey
Now the child journeys can be linked to the launcher journey. Create an array `linkedJourneys` of the following form:
```json
[
{
"id": "",
"title": "",
"label": "<label on the tab of the linked journey>",
"icon": "<name of the icon>"
},
{
"id": "<linked journey id 2>",
"title": "<title of the linked journey>",
"label": "<label on the tab of the linked journey>",
"icon": "<name of the icon>"
}
]
```
Add the `linkedJourneys` array to the key `steps[0].uischema.elements[0].options.linkedJourneys` to the response of the launcher journey creation step. Here is a sample request:
```bash
curl --location --request PUT 'https://journey-config.sls.epilot.io/v1/journey/configuration' \
--header 'Authorization: Bearer <your-auth-token-here>' \
--header 'Content-Type: application/json' \
--data-raw '{
"version": 0,
"settings": {
"runtimeEntities": [
"OPPORTUNITY"
],
"safeModeAutomation": true,
"designId": "<design ID>",
"description": "<optional text description>",
"templateId": "<launcher template ID>"
},
"rules": [],
"logics": [],
"name": "<your journey launcher name>",
"organizationId": "<your organisation id>",
"brandId": "<brand id from the previous step>",
"steps": [
{
"name": "Launcher step",
"schema": {
"type": "object",
"properties": {
"Launcher block": {
"type": "object"
}
},
"required": []
},
"stepId": "New step",
"hideNextButton": true,
"uischema": {
"type": "MainContentCartLayout",
"options": {
"scale": 5
},
"elements": [
[
{
"type": "JourneyLauncherControl",
"options": {
"stickyOnMobile": false,
"stickyOnMobileIndex": 1,
"showPaper": true,
"isNested": false,
"linkedJourneys": [
{
"id": "<linked journey id 1>",
"title": "<title of the linked journey>",
"label": "<label on the tab of the linked journey>",
"icon": "<name of the icon>"
}
]
},
"scope": "#/properties/Launcher block"
}
],
[],
[],
[]
]
}
}
],
"journeyId": "<launcher journey id>",
"revisions": 0,
"lastModifiedAt": "2023-04-10T06:55:08.931Z"
}'
```
The launcher journey is now created from the template, assigned a design, and linked to its child journeys. It is ready to be embedded or shared.