assignment_identities.revealed

Delivered when assignment_identities.revealed 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

assignment_identities.revealedwebhook

View as Markdown

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
4 properties
- assignment_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)$
- 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)$
- revealed_atstringrequired
  format: date-time, pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
- revealed_bystringornullrequired
  2 variants
  One of the following:
  string
  null
linksoptionalmap ofstring
Where to read the current state of what the event is about.

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.