Hive (Dashboard)
Hive dashboard is a powerful all-in-one moderation tool, which enables you to set up rules to combine automated AI moderation with human review.
The Hive Dashboard rule is a rule applied to chat rooms which enables you to use Hive's moderation dashboard to review messages in your chat room.
Integration setup
Configure the integration rule in your Ably dashboard or using the Control API.
The following are the fields specific to Hive dashboard configuration:
Field | Description |
---|---|
Hive API Key | The API key for your Hive dashboard account. |
Chat Room Filter (optional) | A regular expression to match the chat room name. |
Hive setup
To use the Hive Dashboard rule, you first need to set up a Hive account and an application.
Once you have done this you can get an API key from the dashboard settings which you can then use to set up the rule.
When the rule is enabled, it will send all published messages in the room to the dashboard for review. Please note that messages get sent to Hive after they have been published, so users will see them in the chat room until they have been deleted by a moderation rule, although in the case of automatic moderation this will be near-instantaneous. If you want to prevent messages from reaching users until they have been approved automatically by an AI moderation rule, check out the Hive model only rule.
In order for hive dashboard to delete messages, you need to set up an action in the dashboard. The setup is as follows:
- Go to the post actions page in the dashboard.
- Click "+ Create new"
- Ensure that the "Action type" is set to "POST"
- Enter a descriptive name for the action, for example "Delete message"
- Set the "Endpoint URL" field to
https://rest.ably.io/chat/v2/moderation/hive/delete
(if you have a dedicated cluster the domain should be your custom REST domain) - Under "Customize API Request" add the
Authorization
header with the valueBearer <your Base64 encoded Ably API key>
, make sure to Base64 encode the API key you get from the Ably dashboard. - Under "Request Body" add the following two params:
serial
:=Post ID
clientId
:=User ID
- Click "Save"
Please refer to the below screenshot for an example of the action setup:

You should now see the action in the list of actions, and it will be available to human moderators in the dashboard, as well as for use by auto-moderation rules.
Within the Hive dashboard, messages within a room will appear as part of the same group, where the group_id
is the roomId
of the room, and edits to a message will appear as children of the original message.
For more information on how to use the Hive Dashboard, please refer to the Hive Dashboard documentation.