Skip to main content
POST
Create a Webhook
Webhooks will allow you to detect when a specified event occurs. Supported event types include:
  • element_completed → When a step is completed
    • extra_parameters:
      • step_type → One or more step types. Leave empty to include all step types. Supported values are basic, input_text, textarea, link, quiz, post, topic, milestone, file_upload, and form
  • element_pending → When a member submits an answer that needs to be corrected.
    • extra_parameters:
      • step_type → One or more step types. Leave empty to include all applicable step types. Supported values are input_text, textarea, post, topic, milestone, and file_upload
  • member_joining_offer → When a member is added to an offer
    • extra_parameters:
      • offerFilter → An offer ID or multiple offer IDs separated by commas. This event will only trigger if the member is added to an offer that matches the filter
  • new_payment → When a member initiates a new payment (whether it is on a one-time offer price, a multiple installment price, or a subscription)
  • member_inactivity → Will trigger at the same time as the member inactivity notification from SchoolMaker
  • gamification_level_passed → Which will trigger when a level is passed in the community gamification feature
    • extra_parameters:
      • activeLevels → A comma-separated list of level numbers. This event will only trigger if the member has passed a level that is in the list
  • conversation_message_received → When a User receives a new message in a conversation group
    • extra_parameters:
      • user_ids → A list of User IDs. The event will only trigger when one of these Users receives the message. Leave empty to include all Users
      • author_types → Use members or users to filter messages by author type. Leave empty to include messages from both Members and Users
To see the payload for each event, please refer to the Webhooks Payload page.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
webhook_url
string<uri>
required

The URL where webhook payloads will be sent via POST requests. This should be a publicly accessible HTTPS endpoint that can receive and process the webhook events.

event_type
enum<string>
required
Available options:
element_completed,
element_pending,
member_joining_offer,
new_payment,
member_inactivity,
gamification_level_passed,
conversation_message_received
provider
string
extra_parameters
object

Response

201 - application/json

Webhook created

id
string
webhook_url
string
event_type
string
provider
string
extra_parameters
object
created_at
string<date-time>
updated_at
string<date-time>