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 entry-related events. Combines the entry resource with the common webhook envelope fields (event, timestamp, trigger, source).

See the Webhooks guide for a full example payload.

Single entry, including the entrant, form field responses, attachments, contributors, and status.

entrant
object

Entrant who created and owns the entry.

auto_score
integer

Automated score calculated for the entry.

category
object

Category the entry is assigned to.

chapter
object

Chapter the entry is assigned to.

comments
string

Manager comments recorded on the entry, joined into a single string.

contributor_count
integer

Number of contributors linked to the entry.

created
string<date-time>

Date and time when the entry was created.

custom_deadline
string

Custom submission deadline for the entry, or - when none is set.

division
integer | null

Division number assigned to the entry, or null when none is assigned.

eligibility_status
string

Eligibility status of the entry.

files_count
integer

Number of files uploaded to the entry.

form
object

Entry form used to capture the entry.

grant_end_date
string | null

Date when the grant ends, or null when not applicable.

grant_status
object | null

Grant status assigned to the entry, or null when none is set.

local_id
integer

Sequential identifier of the entry within the account.

moderation_status
string

Moderation status of the entry.

parent_category
object | null

Parent of the assigned category, or null when the category has no parent.

payment_status
string

Payment status of the entry.

plagiarism_scan_status
string

Plagiarism scan status of the entry.

review_status
string

Review status of the entry.

season
object

Season the entry belongs to.

slug
string

URL-safe identifier of the entry.

status
string

Submission status of the entry. Possible values include submitted, in_progress, resubmission_required, resubmitted, invited, and not_approved_for_submission.

submitted
string<date-time> | null

Date and time when the entry was submitted, or null when not yet submitted.

tags
string

Tags applied to the entry, as a comma-separated list.

title
string

Title of the entry.

updated
string<date-time>

Date and time when the entry was last updated.

user_comments
string

Comments left by users on the entry, joined into a single string.

entry_fields
object[]

Form field responses captured on the entry.

attachments
object[]

Files attached to the entry.

contributors
object[]

Contributors linked to the entry.

event
string

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

Example:

"Entry created"

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:

"entry_created"

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.