# WalkMe Destination

## Destination Info

* Accepts [Page](/docs/segment/connections/spec/page), [Identify](/docs/segment/connections/spec/identify), [Track](/docs/segment/connections/spec/track) calls.
* Refer to it as **WalkMe** in the [Integrations object.](/docs/segment/guides/filtering-data/#filtering-with-the-integrations-object)
* This integration is **partner owned.** Please reach out to the partner's support for any issues.

### Components

* [Browser](https://github.com/WalkMe/analytics.js-integration-walkme)

## Connection Modes

[Learn more about connection modes.](/docs/segment/connections/destinations/#connection-modes)

### Device-Mode

* web: yes
* mobile: no
* server: no

### Cloud-Mode

* web: no
* mobile: no
* server: no

[WalkMe](https://www.walkme.com/?utm_source=segmentio\&utm_medium=docs\&utm_campaign=partners) Digital Adoption Platform provides guidance, engagement, insights and automation to users.

This destination is maintained by WalkMe. For any issues with the destination, [contact the WalkMe Support team](mailto:support@walkme.com).

## Getting Started

1. From the Segment web app, click **Catalog**.
2. Search for "WalkMe" in the Catalog, select it, and choose which of your sources to connect the destination to.
3. In the WalkMe settings, select an Environment (for example Production, Test etc.)
4. Enter your WalkMe system ID which you can find in your WalkMe Editor under Menu > Snippet tab.
5. You're all set! For specific steps on using Segment data within the WalkMe editor, [read here](https://support.walkme.com/?p=15147\&post_type=ht_kb\&preview=1&_ppp=ab530c4600).

## Page

If you're not familiar with the Segment Specs, take a look to understand what the [Page method](/docs/segment/connections/spec/page/) does. An example call would look like:

```text
analytics.page()
```

Page calls will be sent to WalkMe as a `pageview`.

## Identify

If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/segment/connections/spec/identify/) does. An example call would look like:

```text
analytics.identify('userId123', {
  email: 'john.doe@example.com'
});
```

Identify calls will be sent to WalkMe as an `identify` event.

## Track

If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/segment/connections/spec/track/) does. An example call would look like:

```text
analytics.track('Clicked Login Button')
```

Track calls will be sent to WalkMe as a `track` event.

## Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.

| Field                   | Description                                                                                                     | Required | Type    |
| ----------------------- | --------------------------------------------------------------------------------------------------------------- | -------- | ------- |
| API Key                 |                                                                                                                 | Yes      | string  |
| Custom Directory        | Directory Bucket where files will be stored. Leave it blank by default.                                         | No       | string  |
| Environment             | WalkMe environment that should be loaded (e.g. Test, Production), you can find it in the Editor's Snippet area  | Yes      | string  |
| Integrity Hash          | Sub-resource Integrity (SRI) SHA hash.                                                                          | No       | string  |
| Track WalkMe Events     | If enabled, WalkMe events will be sent to Segment                                                               | No       | boolean |
| Track WalkMe DXA Events | If enabled, WalkMe DXA events will be sent to Segment                                                           | No       | boolean |
| WalkMe system ID        | WalkMe system ID - you can find it in the Editor's Snippet area (GUID parameter)                                | Yes      | string  |