You are viewing documentation for an older version.

Click here to view the latest documentation.

Activation API

With RudderStack’s Activation API, you can fetch enriched user traits stored in your Redis instance and use them for near real-time personalization for your target audience.

You can sync all your customer 360 data from Profiles project to your Redis store. Then, use the Activation API endpoints to retrieve and use the enriched user data for personalization.

Prerequisites

To use the Activation API:

• You must have a working Redis instance in place to use the Activation API
• You must have at least one successful Profiles run
• Your pb_project.yaml > entities must have a feature_views property
• Generate a workspace-level Service Access Token in your RudderStack dashboard with the following permission — this token is required to authenticate and use the API

Token permissions for legacy RBAC system

If you are on the legacy Permissions Management (RBAC) system, your workspace-level Service Access Token should have Admin permissions.

See this documentation for more information on generating the token.

Use Activation API

1. Your Profiles project already uses a warehouse connection whose user/role must have the required permissions for a successful Profiles run. Follow the steps below to create the RudderStack state schema (used to store the sync state) and grant that same user/role full privileges on it.

CREATE SCHEMA "<YOUR_DATABASE>"."_RUDDERSTACK";
GRANT ALL PRIVILEGES ON SCHEMA "<YOUR_DATABASE>"."_RUDDERSTACK" TO ROLE "<YOUR_PROFILES_ROLE>";

CREATE SCHEMA "_rudderstack";
GRANT ALL ON SCHEMA "_rudderstack" TO <YOUR_PROFILES_USER>;
GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA "_rudderstack" TO <YOUR_PROFILES_USER>;

CREATE SCHEMA `_rudderstack`;
GRANT ALL PRIVILEGES ON SCHEMA `_rudderstack` TO `<YOUR_PROFILES_USER>`;

create schema rudderstack_;

GRANT `roles/bigquery.dataOwner`
     ON SCHEMA rudderstack_
     TO "serviceAccount:<SERVICE_ACCOUNT_ID>";

2. In your Profiles project settings, scroll down to Activation API and turn on the Enable sync to Redis toggle.

Permissions required to enable sync to Redis

• New Access Management system:

  • Admins can turn on the Enable sync to Redis toggle by default.
  • Members need to have the Profiles Edit permission for the specific Profiles project.

• Legacy RBAC system: In the legacy Permissions Management (RBAC) system, only Org Admins can turn on this toggle.

3. Enter the account credentials for your Redis instance and click Create. This will also create a Redis destination in your dashboard.

4. Note the destination ID from the Settings tab of your Redis destination.
5. Use the Activation API endpoint to fetch user profiles from your Redis instance.

Authorization

This API uses Bearer Authentication for authenticating all requests. Set the Service Access Token as the bearer token for authentication.

Base URL

https://profiles.rudderstack.com/v2/

Get user profiles

Request body

{
  "entity": <entity_type>,  // User, project, account, etc.
  "destinationId": <redis_destination_id> , // Redis destination ID
  "id": {
    "type": <id_type>,
    "value": <id_value>
  }
}

Sample request

POST /v2/activation HTTP/1.1
Host: profiles.rudderstack.com
Content-Type: application/json
Authorization: Bearer <personal_access_token>
Content-Length: 90

{
 "entity": <entity_type>,
 "destinationId": <redis_destination_id>, // Redis destination ID
 "id": {
   "type": <id_type>,
   "value": <id_value>
 }
}

curl --location 'https://profiles.rudderstack.com/v2/activation' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <personal_access_token>' \
--data '{
 "entity": <entity_type>,
 "destinationId": <redis_destination_id>, // Redis destination ID
 "id": {
   "type": <id_type>,
   "value": <id_value>
 }
}'

const axios = require('axios');
let data = JSON.stringify({
  "destinationId": <redis_destination_id>,
  "entity": <entity_type>,
  "id": {
    "type": <id_type>,
    "value": <id_value>
  }
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://profiles.rudderstack.com/v2/activation',
  headers: {
    'Content-Type': 'application/json',
    'authorization': 'Bearer <personal_access_token>'
  },
  data: data
};

axios.request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

Responses

statusCode: 401
Response: {
  "error": "Unauthorized request. Please check your access token"
}

statusCode: 404
Response: {
  "error": "Invalid Destination. Please verify you are passing the right destination ID"
}

statusCode: 200
Response:
{
  "entity": <entity_type>,
  "id": {
    "type": <id_type>,
    "value": <id_value>
  },
  "data": {
    <traits_from_Redis>
  }
}

statusCode: 200
Response:
{
  "entity": <entity_type>,
  "id": {
    "type": <id_type>,
    "value": <id_value>
  },
  "data": {}
}

Delete user profiles

Request body

Sample request

POST /v2/activation HTTP/1.1
Host: profiles.rudderstack.com
Content-Type: application/json
Authorization: Bearer <personal_access_token>
Content-Length: 90

{
 "entity": <entity_type>,
 "destinationId": <redis_destination_id>, // Redis destination ID
 "id": {
   "type": <id_type>,
   "value": <id_value>
 }
}

curl --location 'https://profiles.rudderstack.com/v2/activation' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <personal_access_token>' \
--data '{
 "entity": <entity_type>,
 "destinationId": <redis_destination_id>, // Redis destination ID
 "id": {
   "type": <id_type>,
   "value": <id_value>
 }
}'

const axios = require('axios');
let data = JSON.stringify({
  "destinationId": <redis_destination_id>,
  "entity": <entity_type>,
  "id": {
    "type": <id_type>,
    "value": <id_value>
  }
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://profiles.rudderstack.com/v2/activation',
  headers: {
    'Content-Type': 'application/json',
    'authorization': 'Bearer <personal_access_token>'
  },
  data: data
};

axios.request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

Responses

statusCode: 200
Response: {
  "deletedKeys": 20,
  "actualKeys": 30
}

statusCode: 400
Response: {
  "message": "id should have at least one item"
}

statusCode: 200
Response: {
  "message": "Internal server error"
}

Use case

You can use the Activation API for real-time personalization. Once you fetch the user traits from your Redis instance via the API, you can pull them into your client application to alter the application behavior in real-time based on user interactions.

You can respond immediately with triggered, user-focused messaging based on actions like page views or app clicks and provide a better customer experience.

Redis configuration

You must have a working Redis instance in place before setting up the connection.

• Address: Enter the public endpoint of your Redis database. If you are using Redis Cloud, you can find this endpoint by going to your Redis database and navigating to Configuration tab > General.

You can also use Amazon ElastiCache for Redis to set up your Redis database. See the ElastiCache documentation to get started.

• Password: Enter the database password. You can find it in the Security section of the Configuration tab:

• Cluster Mode: Turn on this setting if you’re connecting to a Redis cluster.
• Secure: Enable this setting to secure the TLS communication between RudderStack Redis client and your Redis server.

Data mapping

RudderStack creates multiple Reverse ETL sources automatically based on your Profiles project. You will see separate sources connected to the same Redis destination.

The following pb_project.yaml snippet shows the sources to be created:

entities:
  - name: user
    id_types:
      - main_id
      - user_id
      - email
      - salesforce_id
    feature_views:
      using_ids:
        - id: email
          name: features_by_email # Optional. Takes default view name, if not specified.
        - id: salesforce_id
          name: salesforce_id_stitched_features

FAQ

How do I generate a workspace-level Service Access Token to use the Activation API?

Follow these steps to generate a workspace-level Service Access Token to use the Activation API:

Workspace-level Service Access Tokens are linked to a specific workspace — their usage is restricted to workspace-level resources (sources, destinations, transformations, etc.) and APIs.

1. Log in to your RudderStack dashboard.
2. Go to Settings > Access Management > Service Access Tokens.
3. Click the Workspace tab.

4. Click Generate new token.
5. Enter the name of the SAT.
6. Choose the relevant workspace (applicable for a multi-workspace organization) where the token will be applicable. Then, click Next.

7. Under Workspace SAT access policy, configure the access policy for the token with the following permission:

Important: Once generated, you cannot edit the access policy of the workspace-level Service Access Token.

8. Click Generate to generate the token.
9. Note the token and use it to authenticate the Activation API.

Secure the token value — you will not be able to see it again once you click Close.

Why am I getting an error trying to enable API in my instance for a custom project hosted on GitHub?

For GitHub projects, you need to explicitly add the IDs of the custom project that need to be served.

In your pb_project.yaml file, you can specify them as shown:

entities:
  - name: user
    id_types:
      - main_id
      - user_id
      - email
      - salesforce_id
    feature_views:
      name: user_feature_view
      using_ids:
        - id: email
          name: features_by_email
        - id: salesforce_id
          name: salesforce_id_stitched_features

Does RudderStack perform a full sync if I add a new feature to my project?

Yes, RudderStack updates the mappings and automatically sends all columns from the customer 360 view by triggering a full sync.

Suppose I’m running a full sync and the Profiles job is running in parallel and finishes eventually. What happens to the scheduled sync? Does it get queued?

RudderStack first creates a temporary snapshot copy of any sync when it starts. So its syncing the created copy. Even if a Profiles job is running in parallel, the sync - if started - is not impacted by it.