Heartbeat integration

New Member Joined

Fires when a new member joins the community. Members added with Create User or Create Member do not fire it.

New Thread

Fires when a new thread is posted, in any channel or one channel.

2 fields

New Mention in Thread or Comment

Fires when chosen members or groups are @mentioned in a thread or comment.

3 fields

New Event

Fires when a new event is created in the community.

New Direct Message to Admin

Fires when a chosen admin receives a direct message.

1 field

Create User

Create a new user in a Heartbeat community

12 fields

List Members

Lists community members, optionally filtered by text, group, role or admin status.

6 fields

Get Member

Gets one member by user ID, including profile details.

1 field

Find Member by Email

Looks up a member by exact email address.

1 field

Update Member

Updates a member's profile, identified by email. Fields left empty stay as they are.

8 fields

Remove Member (Deactivate)

Deactivates a member by email. Their threads, comments and messages stay; Reactivate Member undoes it.

1 field

Reactivate Member

Gives a deactivated member access to the community again.

1 field

Pre-register Member

Pre-registers a person who becomes a member with this role and groups the first time they log in.

5 fields

List Completed Lessons

Lists a member's completed course lessons, newest completion first.

3 fields

Mark Lessons Completed

Adds lessons to a member's completed lessons. Never removes completions.

3 fields

List Roles

Lists the roles in the community with their IDs.

List Groups

Lists the groups in the community.

2 fields

Get Group

Gets one group with its members.

1 field

Create Group

Creates a group, optionally under a parent group and with initial members.

6 fields

Update Group

Changes a group. Fields left empty stay as they are.

5 fields

Delete Group

Deletes a group. Members stay in the community.

1 field

Add Members to Group

Adds members to a group by email, optionally moving them out of sibling groups.

3 fields

Remove Members from Group

Removes members from a group by email. They stay in the community.

2 fields

List Channels

Lists the channels in the community, optionally only one type.

1 field

List Channel Categories

Lists the channel categories (sidebar sections).

Create Channel Category

Creates a channel category (sidebar section).

1 field

Create Channel

Creates a posts (threads) or chat channel in a category.

8 fields

Update Channel

Changes a channel's name, description, read-only setting or who can access it.

7 fields

Delete Channel

Permanently deletes a channel and all its threads.

1 field

List Threads

Lists threads in a posts channel, newest first, one page at a time.

4 fields

Get Thread

Gets one thread with its comments and replies.

1 field

Create Thread

Posts a new thread in a posts channel.

4 fields

Reply to Thread

Adds a comment to a thread, or a reply to a comment.

5 fields

Send Channel Chat Message

Sends a message to a chat channel.

3 fields

List Channel Chat Messages

Lists messages in a chat channel, newest first, one page at a time.

3 fields

Send Direct Message

Sends a direct message from an admin to a member.

3 fields

Get Direct Chat

Returns the direct chat between two users, creating an empty one if none exists.

2 fields

List Direct Messages

Lists the 100 most recent messages of a direct chat that includes an admin.

1 field

List Events

Lists community events, optionally for one group or a time range.

4 fields

Get Event

Gets one event, optionally with the dates of all its occurrences.

2 fields

Get Event Attendance

Gets who attended the last 10 occurrences of an event.

1 field

Create Event

Creates a community event and invites members, groups or outside guests.

8 fields

List Invitation Links

Lists the invitation links with their role and groups.

Create Invitation Link

Creates an invitation link that gives new members a role and groups.

2 fields

Invite Emails to Invitation Link

Lets these emails join through an invitation link, optionally emailing them the invitation.

3 fields

List Courses

Lists courses with their cohorts, modules and lessons.

Get Lesson

Gets one course lesson with its Markdown content.

1 field

List Documents

Lists the community documents (wiki pages), one page at a time.

2 fields

Get Document

Gets one community document (wiki page) with its Markdown content.

1 field

Custom API Call

Make a custom API call to a specific endpoint

10 fields