Skip to content

scorm_attempt.completed

Delivered when scorm_attempt.completed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock.

POST
scorm_attempt.completedwebhook

Request bodyJSONrequired

  • idstringrequired

    Equal to the webhook-id header and to the outbox event identifier. Deduplicate on it.

  • typestringrequired
  • versionintegerrequired
  • occurred_atstringrequired
    format: date-time
  • tenantobjectrequired
    2 properties
    • idstringrequired
    • slugstringrequired
  • subscription_idstringrequired
  • livemodebooleanrequired
  • dataobjectrequired
    6 properties
    • attemptintegerrequired
      maximum: 9007199254740991
    • course_idstringrequired
      format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
    • score_scalednumberornullrequired
      2 variants

      One of the following:

      • number
      • null
    • scorm_idstringrequired
      format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
    • successpassedorfailedorunknownrequired
    • user_idstringrequired
      format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Returns

2XX

Any 2xx acknowledges the delivery. A 410 disables the subscription. Anything else is retried with exponential backoff and full jitter over about 36 hours.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close