📖
PixieBrix Documentation
🎰

User-Specific Business Logic

Introduction

In this tutorial, you’ll learn how to use PixieBrix’s Team Database feature to implement per-user business logic.

This tutorial covers:

  1. Creating a Team Database to store user profiles/tags
  2. Populating the database using the Developer API
  3. Referencing a team member’s profile to determine brick execution in an mod

Create a Team Database

Create a Team Database in the admin console to store the user profiles:

image

In the dialog, give your database a name:

image

Create a Developer API Service Account

Create a service account

, and add it to one or more groups that you will grant write access to the database

Configure Database Permissions

Configure group permissions for the database:

  • Read: the Group of team members that will be using the mod
  • Write: the Group your Developer API Service Account is in

Populate the Database with Profiles

To update organization database records, use the records endpoint:

  • PUT /api/databases/:databaseId/records/

The payload is the unique record id and data. Use the user’s email (all lowercase) as the id. And pass the custom profile data:

{
  "id": "todd@pixiebrix.com",
  "data": {
    "isCool": true,
    "heightInMeters": 1.93
  }
}

Currently there are no bulk operations available on the database. Therefore, to add/update multiple records on the database, issue multiple requests.

🏎️
The Developer API is currently throttled as 125 requests / min. If you receive a 429 response, wait a minute and the proceed

Mod Setup

Add the PixieBrix session reader brick, to get the email of the team member:

image

Add the “Get data from PixieBrix database” brick:

image

Change the output key to profile, and pass the email for the database record key:

image

⚠️
If the record is not in the database, the mod with fail with a business error

In the subsequent bricks, you can now use the flags on the profile in brick inputs and conditions. For example, to configure a brick to run only if the isCool flag is set for the team member:

image
X