Refersion Destination

You have two options to connect - either automatically within your Refersion dashboard, or manually by copying and pasting an API key into the Segment dashboard.

1. In Refersion, find "Segment" in the Integrations section of the Account > Settings page.
2. After pressing "Enable with Segment Integration" you will choose the first data source from the pop-up screen.
3. When the initial connection is established you will be able to connect additional sources to your Refersion destination.

1. From the Segment web app, click Catalog.
2. Search for "Refersion" in the Catalog, select it, and choose which of your sources to connect the destination to.
3. Once connected, you will be asked to input an API key - which can be found in your Refersion dashboard - which is formatted as publickey.secretkey. You will need to click "Show" to obtain the "Secret Key" portion.

If you're not familiar with the Segment Specs, take a look to understand what the Identify method does. An example call would look like:

1
{
2
  "messageId": "test-message-txsmji",
3
  "timestamp": "2019-05-02T14:14:40.519Z",
4
  "type": "identify",
5
  "email": "test@example.org",
6
  "traits": {
7
    "name": "Peter Gibbons",
8
    "email": "peter@example.com",
9
    "plan": "premium",
10
    "logins": 5,
11
    "address": {
12
      "street": "6th St",
13
      "city": "San Francisco",
14
      "state": "CA",
15
      "postalCode": "94103",
16
      "country": "USA"
17
    }
18
  },
19
  "userId": "test-user-t0zpx"
20
}

Identify calls will be sent to Refersion as an identify event.

All identify requests made to the Refersion destination must contain the following traits in order for a new affiliate to be created:

If you plan on using camelCase or snake_case use it consistently for all your traits to keep the request uniform.

Your request can also only contain the name instead of firstName/lastName or first_name/last_name.

You can use a delete request to remove a certain affiliate from our system.

1
{
2
    "type": "delete",
3
    "channel": "server",
4
    "messageId": "delete-022bb90c-bbac-11e4-8dfc-aa07a5b093db",
5
    "projectId": "abcd123",
6
    "userId": "5678",
7
    "context": [],
8
    "integrations": [],
9
    "email": "peter@example.com",
10
    "receivedAt": "2019-02-19T23:58:54.387Z",
11
    "sentAt": "2019-02-19T21:58:54.387Z",
12
    "originalTimestamp": "2019-02-19T23:58:54.387Z",
13
    "timestamp": "2019-02-19T23:58:54.387Z"
14
}

You can send computed traits and audiences generated using Engage to this destination as a user property. To learn more about Engage, schedule a demo.

For user-property destinations, an 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.

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