Articles on: Developer Documentation

Types of Events

Types of Events


In this article:

  • Overview
  • Event list
  • Learning events
  • Data types
  • Things to keep in mind
  • FAQs


Overview


This is a list of all the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist. If there are events that you would like to see sent that are not listed here, please reach out to support@superpath.io.


You choose which of these events a webhook receives when you register it, under Settings → Integrations → Manage webhooks — see the help article How to Register a Webhook. Each event name below is the exact string that arrives in the event attribute of the event object. You can also read the current list programmatically from GET /webhooks/events/all.


Event list


Event

When it fires

Data type

user.created

A new user has been created

User

user.updated

A user record has been updated

User

user.deleted

A user has been deleted

User

userTeam.created

A user has been added to a Team

UserTeam

userTeam.updated

A user's details in a Team have been updated

UserTeam

userTeam.deleted

A user has been removed from a Team

UserTeam

team.created

A new Team has been created

Team

team.updated

A Team has been updated

Team

team.deleted

A Team has been deleted

Team

learning.created

A user has been assigned a new learning

Learning

learning.updated

A learning has been updated, for example progress or completion

Learning

learning.deleted

A learning has been deleted

Learning

event.created

A new Event has been created

Event

event.updated

An Event has been updated

Event

event.deleted

An Event has been deleted

Event

tenant.updated

Your account has been updated. Shown as Account updated in the event picker

Tenant

form.created

A new Form has been created

Form

form.updated

A Form has been updated

Form

form.deleted

A Form has been deleted

Form

response.created

A new response to a Form has been added

Response

response.updated

A response has been updated

Response

response.deleted

A response has been deleted

Response

content.created

New Content has been added

Content

content.updated

Content has been updated

Content

content.deleted

Content has been deleted

Content

points.created

A user has earned new gamification points

UserPoints

points.updated

A user's gamification points have been updated

UserPoints

points.deleted

A user's gamification points have been deleted

UserPoints

comment.created

A new comment was created

Comment

comment.updated

A comment was updated

Comment

comment.deleted

A comment was deleted

Comment


Learning events


The three learning.* events cover more than one kind of record, because "a learning" in SuperPath can be a piece of assigned learning, a Pathway a user is working through, or a single step within a Pathway. All three arrive under the same event names, so use the learningType field in data to tell them apart:


learningType

What the record is

assignment

A piece of Content, an Event or a Form assigned to a user

pathway

A Pathway assigned to a user

step

A single step inside a Pathway the user is working through


For a step, the data object also carries parentId, parentTitle and parentType, which identify the Pathway the step belongs to.


Data types


The Data type column above names the shape of the data object in the event object:


Data type

What it describes

User

A user record — name, email, position, role, timezone, points totals and status

UserTeam

A user's membership of a Team

Team

A Team record

Learning

Learning assigned to, or progressed by, a user — see Learning events above

Event

An Event in your Library

Tenant

Your SuperPath account and its settings

Form

A Form or quiz

Response

A user's response to a Form

Content

A piece of Content in your Library

UserPoints

A gamification points record for a user, including the action that earned it

Comment

A comment on a record, including its likes and reply counts


Every one of these includes tenantId and id. For the exact fields of each, look at the corresponding resource in the API reference documentation.


Things to keep in mind


  • We may add event types at any time. Handle unrecognised event names gracefully rather than treating them as an error.
  • A single action can produce more than one event — for example, progressing through a Pathway can raise learning.updated for the step and again for the Pathway itself as its progress changes.
  • Both a created and an updated event can arrive in quick succession for the same record when it is created and then immediately modified. Make your handling idempotent.
  • SuperPath does not retry a failed delivery, so do not treat the event stream as a guaranteed, gap-free log. See Delivery and failure behaviour in Webhooks - Get updates in real-time.


FAQs


How do I get the current list of events in code?
Call GET /webhooks/events/all on the authenticated API. It returns each event with the value to subscribe to and the label shown in the app.


Can one webhook subscribe to more than one event?
Yes, and at least one event is required. Subscribe a single webhook to as many events as you like and switch on the event attribute in your handler.


An event I want isn't listed. Can it be added?
Contact support@superpath.io and tell us what you need — the list grows based on customer requests.


Why do I get learning.updated for things that aren't assignments?
Because Pathways and Pathway steps use the same event names. Check data.learningType to see whether the record is an assignment, a pathway or a step.

Updated on: 25/07/2026

Was this article helpful?

Share your feedback

Cancel

Thank you!