# Lumen Destination

## Destination Info

* Accepts [Identify](/docs/segment/connections/spec/identify), [Track](/docs/segment/connections/spec/track) calls.
* Refer to it as **Lumen** 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.

[Lumen](https://uselumen.co/?utm_source=segmentio\&utm_medium=docs\&utm_campaign=partners) helps companies engage the right customers with ease via data-driven messaging through push notifications, SMS, and emails to meet business and marketing objectives.

From drip campaigns, special coupon offers, growth hacking, activating inactive customers and more, Lumen does the heavy lifting while you focus on other business operations.

Lumen maintains this destination. For any issues with the destination, [contact the Lumen Support team](mailto:hello@uselumen.co).

## Getting Started

1. From the Destinations catalog page in the Segment App, click **Add Destination**.
2. Search for **Lumen** and select the **Lumen** destination.
3. Choose which Source should send data to the Lumen destination.
4. Go to the [Lumen dashboard](https://app.uselumen.co) and navigate to the API tab on the settings page.
5. Copy the API key.
6. Go back to Segment and paste the API Key in the Lumen destination settings.

## Supported methods

Lumen supports the following methods, as specified in the [Segment Spec](/docs/segment/connections/spec).

### Identify

Send [Identify](/docs/segment/connections/spec/identify) calls to create or update a user's record. The `userId` becomes the user's primary identifier.

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

If the identifier doesn't exist, a new user record is created. If the identifier already exist, Segment updates the user record. For example:

Segment sends Identify calls to Lumen as an `identify` event.

### Track

Send [Track](/docs/segment/connections/spec/track) calls to track a user's activity or action. For example:

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

Segment sends Track calls to Lumen as a `track` event.

## Engage

You can send computed traits and audiences generated using [Engage](/docs/segment/engage) to this destination as a **user property**. To learn more about Engage, schedule a [demo](https://segment.com/contact/demo).

For user-property destinations, an [identify](/docs/segment/connections/spec/identify/) call is sent to the destination for each user being added and removed. The property name is the snake\_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property `order_completed_last_30days: true`. When the user no longer satisfies this condition (for example, it's been more than 30 days since their last order), Engage sets that value to `false`.

When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

> \[!NOTE]
>
> Real-time audience syncs to Lumen  may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected.

## Settings

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

| Field   | Description                                                         | Required | Type   |
| ------- | ------------------------------------------------------------------- | -------- | ------ |
| API Key | You can find your API key on your dashboard on the settings section | Yes      | string |