Identify

The identify call lets you add a new user or update an existing user with the latest information like the user's dripId,email,name, etc.

If you provide the Campaign ID in the dashboard while setting up the destination, RudderStack will subscribe every user to this campaign ID by default. Alternatively, you can also send the information via the identify call using externalId as shown in the code snippet below. Note that this takes a higher precedence than the campaign ID provided in the RudderStack dashboard.

A sample identify call is as shown below:

Copy
rudderanalytics.identify(
  "user123",
  {
    email: "sampleuser@testmail.com",
    firstName: "Demo",
    lastName: "Example",
    tags: ["tag1", "tag2"],
    customFields: {
      filter1: "filterval1",
    },
  },
  {
    externalId: [
      {
        type: "dripCampaignId",
        id: "<your campaign id>",
      },
      {
        type: "dripId",
        id: "<user's drip id>",
      },
    ],
  }
)

Identify Mapping

The following table includes all the fields in identify call with their relative mapping to the Drip fields:

When you provide the Campaign ID, you can also send some extra fields with the call.

The following table lists all the supported fields for the campaign call:

Track

The track call lets you record the user events and the information associated with them, like action, occurred_at, and customFields. Either id or email must be provided in this call.

The User Creation Mode option in the RudderStack dashboard lets you create a user with their email if they don't already exist. If you don't want new users to be created, disable this option.

A sample track call is as shown below:

Copy
rudderanalytics.track(
  "Event Name",
  {
    email: "sampleuser@testmail.com",
    affiliation: "custom_store",
    order_id: "123456",
    products: [
      {
        name: "product_name",
        price: 10.0,
      },
    ],
  },
  {
    externalId: [
      {
        type: "dripId",
        id: "<user's drip id>",
      },
    ],
  }
)

Special Events

You can create or update a user order if the event name belongs to either of the following special events:

• order updated
• order completed
• order refunded
• order cancelled
• checkout started
• fulfilled / order fulfilled

Track Fields

A track call can contain the following fields:

For the special events mentioned above, the following fields are also supported:

Note that products is an array of objects. Every object in this array can contain the following fields: