Skip to main content
WEBHOOK

Headers

Signature
string
required

HMAC SHA256 signature of the request body. Generated using the webhook's signing key and the raw JSON payload.

Generate the same value in your endpoint and compare it with this header to validate the webhook payload.

Example:

"a1b2c3d4e5f67890abcdef1234567890abcdef1234567890abcdef1234567890"

Body

application/json

Payload delivered for assignment-related events.

Single scoring task for an application, addressed to either a reviewer or a role within a given round and score set.

application
object

Application the assignment refers to.

category
object

Category the application belongs to.

chapter
object

Chapter the category belongs to.

comments
object | null

Comments attached to the assignment, null for role-based assignments.

created
string<date-time>

Date and time when the assignment was created.

form
string

Slug of the form attached to the application.

method
string

How the assignment was created, for example Manual, Automatic (Panel), Recused, or Stray.

panels
object[]

Panels the assignment is associated with.

reviewer
object | null

Reviewer assigned to score the application, null for role-based assignments.

role
object | null

Role assigned to score the application, null for reviewer-specific assignments.

rounds
object[]

Rounds the assignment applies to.

score
object | null

Score for this assignment, formatted per the score-set mode, null when no score has been recorded.

score_set
object | null

Score set used to evaluate the application.

slug
string

Short URL-safe identifier for the assignment.

status
string

Current state of the assignment, for example To be scored, In progress, or Complete.

updated
string<date-time>

Date and time when the assignment was last updated.

event
string

Human-readable name of the event that triggered the webhook.

Example:

"Assignment completed"

timestamp
string<date-time>

ISO 8601 formatted datetime indicating when the event occurred.

Example:

"2020-01-01T00:00:00Z"

trigger
string

Machine-readable event key that fired the webhook. Full list of events can be found here.

Example:

"assignment_completed"

source
enum<string>
default:ui

Origin of the change that triggered the event.

Available options:
ui,
api

Response

200

Return any 2xx status code to acknowledge receipt of the event.