Link web activity to user

v1.0.0

💡 You don't need to use this endpoint if you use our JavaScript snippet in your application.

This endpoint is used to link web activity to a user in your application. This will help you discover which channels and campaigns work best.

When our JavaScript snippet is embedded on your website, blog or landing pages, a cookie named "__journey" will be set.

This will only work if your website and application are under the same top level domain.

Website, blog or landing pages

blog.my-domain.tld
landing-page.my-domain.tld

Application

app.my-domain.tld

The cookie on my-domain.tld will also be send to your app domain.

You should call this endpoint after the user succesfully logged in (so that you know the user's ID). Use the value of the cookie as device ID.

Input

{
  "type": "object",
  "description": "Link web activity to user",
  "required": [
    "deviceId",
    "identification"
  ],
  "properties": {
    "deviceId": {
      "type": "string",
      "format": "non-empty-string"
    },
    "identification": {
      "type": "object",
      "description": "User identification requires a userId, email or both",
      "properties": {
        "email": {
          "type": "string",
          "format": "email",
          "description": "Email address of the user"
        },
        "userId": {
          "type": "string",
          "format": "user-id",
          "description": "Unique identifier for the user in your database"
        }
      }
    }
  }
}

Output

{
  "type": "object"
}