v1

latestOpenAPI 3.1.02026-07-141045121.7 KB

Path

Path session user status updated

Sent to your endpoint when a learner's status in a path session changes. This event is emitted once per status transition (e.g. onTime → late, onTime → successful). It is also emitted the first time a status is computed for a learner after enrollment. Each status change results from a tracking recalculation triggered by learner activity or other platform processes — for example, when a session opens or when a mandatory step is added to a path. One recalculation may affect multiple learners at once, producing bursts of webhook events. See our Webhook processing best practices guide (https://360learning.readme.io/docs/webhooks-processing-best-practices).

postWebhookpath.session.user.status.updated

Headers

webhook-signaturestring required

Example:v1,4UHnozIIxoqswxyYsplgMpo1w5JaUjaPDlg5dm8n1SE=

The signature of the event payload, used to verify the authenticity of the event. If multiple signatures are present, they are space delimited.

webhook-idstring required

Example:msg_35bE2UOtsaBIqUl7VW4mLuR9q2B

The unique identifier of the event. It is the same ID for the retry attempts of the same event.

webhook-timestampstring required

Example:1763370163

The date and time when the event was emitted, in the Unix epoch format (number of seconds that have elapsed since January 1, 1970).

Payload

type'path.session.user.status.updated' required

The type of the event.

timestampinteger required

The date and time when the event was triggered in your platform, in the Unix epoch format (number of milliseconds that have elapsed since January 1, 1970).

Example payload

{
  "type": "path.session.user.status.updated",
  "data": {
    "userId": "507f1f77bcf86cd799439011",
    "pathId": "507f1f77bcf86cd799439011",
    "sessionId": "507f1f77bcf86cd799439011",
    "enrollmentId": "507f1f77bcf86cd799439011"
  }
}

Response

The event is considered as accepted for any 2xx response code.