API

The Heylo API can be used to manage members on the Heylo platform. It requires a Heylo Enterprise subscription.

Getting started

Rate Limits

The API endpoints allow a max of 5 concurrent requests. While there is no strict rate limit implemented right now, it is best to issue a single request at a time and allow it to complete before issuing another.

Credentials

The Heylo team will issue you with an API key for your group or organization (if on the Enterprise plan). Replace HEYLO_API_KEY below with your API key. If you ever need to rotate or delete an API key, please contact the Heylo team at [email protected].

Endpoints

Our API currently exposes two endpoints:

• https://us-central1-piccup-82257.cloudfunctions.net/apiv1-create
• https://us-central1-piccup-82257.cloudfunctions.net/apiv1-remove

Endpoints will be added in the future for update and fetch operations.

Example Usage

Creating and sending a personalized invite by email:

Create Invite

Used to send an personalized invitation out to a member for a specific group on Heylo.

Parameters

• communityId: The Heylo group ID to which the member is being invited.
• member: The details of the member being invited.
  • birthDate: The birth date of the member in the format 'YYYY-MM-DD'.
  • email: The email of the member.
  • emergencyContactName: The name of the emergency contact for the member.
  • emergencyContactPhoneNumber: The phone number of the emergency contact for the member.
  • emergencyContactRelationship: The relationship of the emergency contact to the member.
  • firstName: The first name of the member.
  • gender: The gender of the member. Can be one of ['male', 'female', 'non-binary', 'decline'].
  • lastName: The last name of the member.
  • memberSinceMonth: The month the member joined, formatted as Jan, Feb, etc.
  • memberSinceYear: The year the member joined, formatted as YYYY.
  • phoneNumber: The phone number of the member.
  • userId: The stable ID of the user in your system.
• replyToEmail: The email to reply to for the invite.
• suppressEmails (boolean): If true, Heylo invite emails and reminders will not be sent to the invitee.
• type:  "invite"

Remove Member

Note, this operation will also remove any pending invites that were previously created for the [userId, communityId] pair.

Parameters

• communityId: The Heylo group ID from which to remove the member.
• type:  "member"
• userId: The stable ID of the user in your system.