> ## Documentation Index
> Fetch the complete documentation index at: https://docs.runalloy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Flock

> Integration details and setup guide for the Flock connector in Alloy Automation.

## Pre-Built Tooling

| Category                            | Details                            |
| ----------------------------------- | ---------------------------------- |
| **Authentication**                  | API Key (Authorization header)     |
| **Two-Way Sync**                    | Yes                                |
| **Events Supported**                | Yes (Webhooks)                     |
| **Realtime**                        | Yes                                |
| **Supports Rate Limiting**          | Yes                                |
| **Authentication Scopes Supported** | N/A (API Key based authentication) |

***

## Objects Supported

Alloy Automation supports syncing the following objects from **Flock**:

* **Messages**
* **Channels**
* **Users**
* **Groups**
* **Conversations**
* **Files**
* **Events**
* **Notifications**

***

## Set Up Guide

### Trial Access

| Question                                           | Answer                                                                                                                   |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| **Offers free trial?**                             | Yes. Flock offers a free plan for small teams. Sign up at [https://www.flock.com](https://www.flock.com) to get started. |
| **Requires requires paid sandbox**                 | No paid sandbox required. You can use the free plan for testing.                                                         |
| **Requires partnership to obtain authentication?** | No. API credentials can be obtained directly from the Flock Admin Panel.                                                 |

***

### Authentication (API Key)

Flock uses API Key authentication via the Authorization header.

1. Log in to your **Flock account** at [https://www.flock.com](https://www.flock.com).
2. Navigate to the **Flock Admin Panel** at [https://admin.flock.com](https://admin.flock.com).
3. Go to **App Store** → **Build Your Own** → **Create a new app**.
4. Configure your app settings and generate your **API Token**.
5. Enter your **API Token** into Alloy Automation (used in the Authorization header).

#### API Documentation

For detailed API documentation, visit: [https://docs.flock.com/display/flockos/Flock+API](https://docs.flock.com/display/flockos/Flock+API)

#### Important Notes

* Flock API tokens are specific to the app you create
* Tokens provide access to channels, messages, and users based on app permissions
* Different scopes can be configured when creating your Flock app
* Keep your API token secure as it provides access to team communications

***

## Use Cases

### 1) Team notification automation

Send automated notifications to Flock channels when important events occur in other systems, such as new customer signups, support tickets, or sales updates.

### 2) Message synchronization

Sync messages between Flock and other communication platforms or archive Flock conversations to external storage for compliance and record-keeping.

### 3) Bot integration

Build custom Flock bots that respond to commands, automate workflows, and provide information to team members directly within Flock channels.

### 4) User management

Automatically provision Flock users when employees are added to your HRIS system and manage user permissions across your organization.

### 5) File sharing automation

Automatically share files from external systems (like Google Drive or Dropbox) to relevant Flock channels, keeping teams informed of new resources.

***

## API Gotchas

* **Token permissions:** Flock API tokens have specific permissions based on how the app is configured. Ensure your app has the necessary scopes for the operations you need.
* **Rate limiting:** Flock enforces rate limits on API requests. Implement retry logic with exponential backoff when you receive rate limit errors.
* **Channel access:** Bots and integrations can only access channels they've been invited to. Ensure your bot is added to the appropriate channels before attempting to send messages.
* **Message formatting:** Flock supports rich text formatting with special syntax. Ensure messages are properly formatted to display correctly in the Flock UI.
* **Webhook verification:** When setting up webhooks, Flock may require verification. Implement proper webhook signature validation for security.

> For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**.