Types of Events

In this article:

• Overview
• Event list
• Learning events
• Certificate 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

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:

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

Certificate events

There are two kinds of certificate event:

• certificate.* is about the certificate in your Library itself, for example its name, provider or how long it stays valid.
• userCertificate.* is about one user's awarded copy of a certificate.

Deleting a certificate from your Library also sends userCertificate.deleted for every user who held it.

In a UserCertificate, certificateFile is the link to the PDF awarded to that user. certificateUrl is the provider link set on the certificate, which is the same for everyone who holds it. dateAwarded and dateExpires give the award and expiry dates. dateExpires is null when the certificate does not expire.

A certificate synced to an HR system can send userCertificate.created followed shortly by one userCertificate.updated, when the HR system's record id is added.

Data types

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

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 retries a failed delivery for about 8.5 hours and then stops, so do not treat the event stream as a guaranteed, gap-free log. A retry can also repeat a delivery your endpoint already processed: use the SuperPath-Delivery-Id header to skip it. See Delivery, retries and failures 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: 26/10/2026