An instance of Buzz supports multiple accounts with segregated data. However, there are scenarios where multiple instances of Buzz must interact, and the uniqueness of an auto-generated key, such as `account_id`, cannot be assured. To solve this problem, each instance of Buzz includes a "Buzz Key", set by the system administrator.

For most objects in the API, the Buzz Key has no effect. However, for objects that have the potential to be consumed by a shared system, the Buzz Key is used to enforce object uniqueness. For example, in the Segment object, there is both a `segment_id` field and a `segment_key` field. The latter is used for targeting segments, sharing segments, and otherwise working with the object. The reason is because segments are often shared between Accounts, and it is possible to imagine a scenario where multiple Buzz instances will need to share segments.

## Conventions

Some considerations about the Buzz Key:

  • Buzz Keys must be unique within the overall Beeswax cloud

  • The value can never be changed once set

  • The value must only use alphanumeric characters

## Usage

Where Buzz Key is used:

  • The Buzz [Authentication](🔗) cookie is named `<buzz_key>_<cookie_name>`

  • Segments are uniquely identified by the `segment_key` field, which is formatted as `<buzz_key>/<segment_id>`

  • Creative Assets are uploaded to a directory with the path `/<buzz_key>/<account_id>/<advertiser_id>`

  • Segment sUpload are uploaded to a directory with the path `/<buzz_key>/<account_id>`

  • The `{{BUZZ_KEY}}` [macro](🔗) can be used in creatives.