> ## Documentation Index
> Fetch the complete documentation index at: https://developers.upmarket.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Example application

> Try Upmarket by using the example application.

Using Upmarket starts with connecting your product to the Upmarket API. There are two parts to do this, front-end functions and a backend service.

<img height="200" src="https://mintcdn.com/upmarket/aCt-bwLvNy-oAsgD/images/upmarket-architecture-diagram.png?fit=max&auto=format&n=aCt-bwLvNy-oAsgD&q=85&s=eea5ff170f10d5abf5aa57669e6556fa" data-path="images/upmarket-architecture-diagram.png" />

Note: Before starting with the example application, get your API token from Upmarket <a href="/api-reference/endpoints/authentication/authentication">here </a>.

## 1. Deploy the example backend

To get started with the example application, set up the NodeJs example backend
by following the instructions in the <a href="https://github.com/proxiplace/upmarket-examples/tree/main/server/nodejs">README</a>.
You can either run the backend locally or deploy it to Heroku with a free account.
The example backend works with the example application to authenticate the requests and submit them to the Upmarket API.

## 2. Run the example application

Build and run the example application from <a href="https://github.com/proxiplace/upmarket-examples/tree/main/client/typescript">here</a>.

## 3. Send events to the API

After you have the example running, sign into the example application to submit a sign\_in event.
The event creation will use the generated customer\_id from the initialize step.

<img height="200" src="https://mintcdn.com/upmarket/aCt-bwLvNy-oAsgD/images/upmarket-example-sign-in.png?fit=max&auto=format&n=aCt-bwLvNy-oAsgD&q=85&s=c8b6d12b28143fb8750ea62080175eb5" data-path="images/upmarket-example-sign-in.png" />

Note: You will need the **journey\_id** from the Upmarket Dashboard. When you navigate to the Journey page, it will be displayed in the URL.

<img height="200" src="https://mintcdn.com/upmarket/aCt-bwLvNy-oAsgD/images/upmarket_example_journey_id.png?fit=max&auto=format&n=aCt-bwLvNy-oAsgD&q=85&s=ed4920476a2b2c067fe0feab26495b80" data-path="images/upmarket_example_journey_id.png" />

## 4. View events in the Dashboard

You can view streamed events from the example application to Upmarket from the **Journey > Event history** tab.

<img height="200" src="https://mintcdn.com/upmarket/aCt-bwLvNy-oAsgD/images/upmarket_example_history.png?fit=max&auto=format&n=aCt-bwLvNy-oAsgD&q=85&s=022d76956ce488d50d9e1bd2c6a4ac3a" data-path="images/upmarket_example_history.png" />

## 5. Trigger Boosts in the Dashboard

You can now use events to trigger Boosts that perform actions like sending emails, notifying the team, and creating contacts.

<img height="200" src="https://mintcdn.com/upmarket/aCt-bwLvNy-oAsgD/images/upmarket_example_boost.png?fit=max&auto=format&n=aCt-bwLvNy-oAsgD&q=85&s=275400e96a3ecd366d17d8e4b901e9b6" data-path="images/upmarket_example_boost.png" />
