Sign in

v1

latestOpenAPI 3.0.0http://www.apache.org/licenses/LICENSE-2.0.html2026-07-14543167.2 KB
events

Create a new Event in a Heartbeat community

put/events

Request body

namestring required
descriptionstring
startTimestring date-time required
durationnumber required
locationstring required

Where the event will be held. If the string 'HEARTBEAT' is provided, then the event will take place in a Heartbeat voice channel. If the string 'ZOOM' is provided, then the event will take place in a custom Zoom link (this option can only be chosen if a Zoom account has been integrated with Heartbeat). Otherwise, the provided string will be passed directly to the Custom location field.

invitedUsersstring[]

A list of users that should be invited to the event. If the email matches an existing Heartbeat user, the Heartbeat user will be invited. Otherwise, an event invite will be sent directly to the provided email address. If both invitedUsers & invitedGroups are empty, the event will be open to everyone in the community.

invitedGroupsstring[]

A list of groups that should be invited to the event. If both invitedUsers & invitedGroups are empty, the event will be open to everyone in the community.

Example request

{
  "name": "Community Onboarding",
  "description": "A time for everyone to meet each other & understand what our community is all about",
  "location": "ZOOM"
}

Response

Successful response