# BuzzMonitor

### Overview

Birdie's BuzzMonitor integration enables users to import social interactions (posts, comments and DMs) straight from the BuzzMonitor API. Below are the key steps to setting up the integration so Birdie can pull data from your environment.

### Requirements

* **BuzzMonitor user**: The user e-mail address tied with the BuzzMonitor platform. (called `bm_user`)
* **BuzzMonitor API Key**: A random unique key generated by BuzzMonitor that authenticates and allows communication between the platform and external systems. (called `api_key`)
* **Platforms sources**: The platforms sources are included in the payload as `report_source` and are used to filter specific platforms and pages, defining which platform(s) the connector will request data from and which page(s) the data is linked to.

The documentation for the **BuzzMonitor API** is private and requires special access. You will need to contact the BuzzMonitor team and request the access.

### Setup in BuzzMonitor

For Birdie to be able to access the **BuzzMonitor API**, you’ll need to contact the BuzzMonitor team and request a **payload** containing all the required information, including authentication details.

{% hint style="warning" %}
The BuzzMonitor team may provide the payload for specific requirements (for example: filter only social media posts and comments, or filter only social media private conversations). The Birdie connector is configured to ignore all filters — we will handle all types of interactions.
{% endhint %}

The payload is in JSON format and should look something like this (this example contains the minimum required fields to work with the BuzzMonitor API):

{% code title="buzzmonitor\_payload.json" %}

```json
{
  "authentication_params": {
    "bm_user": "...",
    "api_key": "..."
  },
  "general_params": {
    "timezone": "-3.0",
    "until": "20250821595959",
    "since": "20250821000000",
    "services": [
      "facebook"
    ]
  },
  "report_sources": {
    "facebook_pages_wall": [
      {
        "name": "...",
        "user": "...",
        "other_pages": false,
        "page_id": "...",
        "source": "..."
      }
    ],
    "instagram": [
      {
        "name": "...",
        "user": "...",
        "bm_user": "..."
      }
    ]
  }
}
```

{% endcode %}

{% hint style="warning" %}
The payload may contain more information; this example contains the minimum required fields to work with the BuzzMonitor API.
{% endhint %}

### Data in scope

#### Sources

The connector currently supports:

* `facebook_private_messages` (DMs)
* `facebook_page_wall` (Posts and Comments)
* `instagram` (DMs, posts and comments)
* `linkedin_updates` (Posts, comments and mentions)

#### Source fields

Each source requires different fields. The only common field is `name`, which is required for all types of source.

* facebook (page\_wall and private\_messages)
  * `name`
  * `user`
  * `page_id`
  * `other_pages`
* instagram
  * `name`
  * `user`
  * `bm_user`
* linkedin
  * `name`

#### Interaction types

The BuzzMonitor platform supports these interaction types:

* Public interactions:
  * `post`
  * `comment`
  * `comment_reply`
  * `reply`
  * `mention`
  * `comment_from_mention`
  * `reels`
  * `ad` (Promoted posts)
  * `carousel_album` (Instagram carousel)
* Private interactions (DMs):
  * `direct_message`
  * `message`

### Connect to Birdie

Through this integration, you can import social media (posts and comments) and conversations (direct messages/inbox).

For each interaction, we extract the main fields for that interaction, such as Channel, Status, Priority, Tags, Author Name, Text, etc.