Use the Heartbeat connector to build and manage online communities.
Integrating your application with Heartbeat lets you use these operations in an automation. It exposes 12 actions, listed below. Add the connector from the Connections area, authenticate, then select its operations in the automation builder. Capabilities: actions.
Authentication
Before you begin, make sure you have the following information:
Connection Name: Choose a meaningful name for your connection. This name helps you identify the connection within your application or integration settings.
Authentication Type: The authentication method for this connector is defined in the connection setup. Select the connector in the Connections area to see the fields it requires.
Obtaining Your API Key
Log in to your Heartbeat community as an admin.
Go to Settings, then open System.
Click API Keys.
Click Create API Key to generate a new key.
Copy the generated API key and store it securely for authentication.
Actions
Action Name | Description |
|---|---|
Add users to a group | Add users to a group in Heartbeat |
Channel categories | Channel categories in Heartbeat |
Create a channel | Create a channel in Heartbeat |
Create a comment | Create a comment in Heartbeat |
Create a group | Create a group in Heartbeat |
Create a thread | Create a thread in Heartbeat |
Create an event | Create an event in Heartbeat |
Deactivate a user | Deactivate a user in Heartbeat |
Find users | Find users in Heartbeat |
Invite users | Invite users in Heartbeat |
Remove users from a group | Remove users from a group in Heartbeat |
Send direct message | Send direct message in Heartbeat |