On Entry Status Change

Estimated reading: 3 minutes 115 views

Summary: A breakdown of the data returned to you through the Zealous API when an entry's status is changed (e.g. sent to a round).

This webhook is triggered if the status of an entry change.

This includes actions such as entries:

Moving moving to round
Declined in a round
Deleted by an Admin
Removed by the candidate

This includes all works made as part of this submission, as well as payment information for that one entry.

Parameters

api_key (required)

The API key you have generated on Zealous. Keep it safe, since it gives anyone with it access to your data.

opportunity_id (required)

The ID of the opportunity you wish this webhook to listen to.

entry_id (optional)

The ID of the entry you wish to load.

Response

Returns the Submission object belonging to the opportunity_id.

This includes:

Action (action…)

Details action that was undertaken on an entry. This includes when the action happened and who actioned it.

Zealous publishes the following actions to the webhook currently:

moved to round

when an entry is moved to another round by an admin.

declined in round

when an entry is declined in the round by an admin.

removed

when an entry is removed by an admin.

dropped out

when the candidate removed their own submission from your opportunity.

Submission (submission_…)

Basic details relating to the submission, such as unique ids, the title, description, categories and more. All data linked to the submission object starts with submission_

Candidate (candidate_…)

Key data relating to the candidate who’s submission status changed. This includes name, email, ids and more. All data linked to the submission object starts with candidate_

Payment Details (“payment”:)

If you take a payment, the “payment:” object will also be provided with details such as amount, currency, tax breakdown etc.

{
  "opportunity_id": "MnXZOXXXXXXXXXXXXXXX",
  "opportunity_name": "Incredible Awards",	

  "action": "moved to round",
  "actioned_by_name": "Jane Chen",
  "actioned_by_id": "he5UxOdXXXXXXXXXXXXX",
  "actioned_on": "2023-10-23T15:49:23+0000",
	
  "submission_id": "njTvtzXXXXXXXXXXXXXX",
  "submission_short_id": "AA001",
  "submission_status": "Round 1",
  "submission_category ": "Category A",
  "submission_url": "https://zealous.co/entry/opportunity/0/candidate/entry/?..",

  "candidate_id": "fFAuHjXXXXXXXXXXXXXX",
  "candidate_email": "[email protected]",
  "candidate_firstname": "Guy",
  "candidate_surname": "Armitage",
  "candidate_url": "https://zealous.co/guy/portfolio/"

  }