Bridge App
Automatically send your community's data to outside services on a schedule.
Installing and managing Apps and Bots requires Root on desktop. Once installed into a community, Apps and Bots can be used on Root desktop and mobile.
What is Bridge?
Bridge is a data export app that sends snapshots of your community's information to external services via webhooks. You choose which data to include (channels, roles, member counts, and more), point it at a URL, and Bridge delivers a JSON payload on a regular schedule. This lets you feed community data into dashboards, bots, analytics tools, or any service that accepts HTTP webhooks.
How it works
A bridge is a configured webhook export. Each bridge defines a target URL, which community data fields to include, and optional custom fields. Bridge delivers the selected data as a JSON payload to the target URL on a fixed schedule.
Data fields
When creating a bridge, you select which community data to include in each delivery. Fields are grouped into categories:
| Category | Fields |
|---|---|
| Community Info | Community Name, Community Icon |
| Member Statistics | Member Count |
| Structure | Channels, Channel Groups, Roles |
| Voice | Voice Channels |
Only selected fields appear in the delivered payload. You can change your selection at any time by editing the bridge.
Custom fields
Each bridge can include custom fields: key-value pairs that are added to every delivery. Use these to tag payloads with identifiers, environment names, or any metadata your receiving service needs.
Delivery schedule
Bridges deliver data every 15 minutes. Bridge checks for due deliveries every 60 seconds, builds a snapshot of the selected community data, and sends it as an HTTP POST request to the target URL. The request times out after 10 seconds if the target does not respond. Each delivery is a single JSON object with these top-level keys:
communityId,exportId,exportName, andtimestamp: identify your community and this bridge, and record when the snapshot was taken.data: the selected community data fields (channels, roles, and so on).custom: your custom key-value fields.
Statuses
Each bridge has a status that reflects its current state:
| Status | Meaning |
|---|---|
| Active | Delivering on schedule. |
| Error | The last delivery failed. Bridge continues to retry on schedule and returns to Active when a delivery succeeds. |
Delivery logs
Every delivery attempt is recorded in a log. Each log entry shows the time of the attempt, whether the delivery succeeded, the HTTP status code returned, how long the request took, the payload size, and any error message if it failed. Use delivery logs to diagnose issues with your receiving service.
Roles and permissions
Bridge uses a single permission group configured by community owners.
| Role | Description |
|---|---|
| Bridge Admins | Users and roles who can create and manage webhook data exports. |
What Bridge Admins can do
- Create, edit, and delete bridges
- Select data fields and custom fields
- Test deliveries on demand
- View delivery logs
Members without the Bridge Admin permission cannot see or interact with Bridge.
Create a bridge
Bridge Admins can create new webhook exports.
- Select Create Bridge (or Create Your First Bridge if you have none yet).
- Enter a Name for the bridge.
- Enter the Webhook URL where payloads should be delivered.
- Select at least one data field to include in deliveries.
- Optionally add custom fields (key-value pairs).
- Select Save.
The bridge starts in Active status and delivers its first payload on the next delivery cycle, usually within a minute.
Create bridge fields
| Field | Required | Limit | Notes |
|---|---|---|---|
| Name | Yes | 100 characters | A descriptive label for this bridge |
| Webhook URL | Yes | None | The HTTP endpoint that receives payloads |
| Data Fields | Yes (at least 1) | 7 available | Select which community data to include |
| Custom Fields | No | None | Key-value pairs added to every delivery |
Test a bridge
Bridge Admins can trigger an immediate test delivery to verify the webhook URL and payload.
- Open an existing bridge.
- Select Test.
Bridge sends a delivery immediately using the bridge's current settings. The result appears in the delivery logs.
Edit a bridge
Bridge Admins can update any bridge's settings.
- Open the bridge you want to edit.
- Update the Name, Webhook URL, data fields, or custom fields.
- Select Save.
Changes take effect on the next scheduled delivery.
Delete a bridge
Bridge Admins can permanently remove a bridge.
- Open the bridge you want to delete.
- Select Delete.
- Confirm the deletion.
Deleting a bridge stops all future deliveries and removes its delivery logs. This action cannot be undone.