Skip to content

course_job.completed

Delivered when course_job.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
course_job.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
    • course_idstringornullrequired
      2 variants

      One of the following:

      • string
      • null
    • issue_countintegerrequired
      maximum: 9007199254740991, minimum: -9007199254740991
    • job_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)$
    • kindbackuporrestoreorcopyorimportorresetormoodle_import+6 morerequired
    • requested_bystringornullrequired
      2 variants

      One of the following:

      • string
      • null
    • target_course_idstringornullrequired
      2 variants

      One of the following:

      • string
      • null

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