{"id":12234,"date":"2023-11-22T11:18:04","date_gmt":"2023-11-22T11:18:04","guid":{"rendered":"https:\/\/zealous.co\/help\/docs\/zealous-api\/triggers-12084\/on-entry-status-change\/"},"modified":"2023-12-11T17:26:33","modified_gmt":"2023-12-11T17:26:33","slug":"on-entry-status-change-12234","status":"publish","type":"docs","link":"https:\/\/zealous.co\/help\/docs\/api\/triggers\/on-entry-status-change-12234\/","title":{"rendered":"On Entry Status Change"},"content":{"rendered":"\n<div class=\"wp-block-columns alignwide is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\">\n<p>This webhook is triggered if the status of an entry change. <\/p>\n\n\n\n<p>This includes actions such as entries:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Moving moving to round<\/li>\n\n\n\n<li>Declined in a round<\/li>\n\n\n\n<li>Deleted by an Admin<\/li>\n\n\n\n<li>Removed by the candidate<\/li>\n<\/ul>\n\n\n\n<p>This includes all works made as part of this submission, as well as payment information for that one entry.<\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column highlighted is-layout-flow wp-block-column-is-layout-flow\">\n<p><strong>Parameters<\/strong><\/p>\n\n\n\n<hr class=\"wp-block-separator has-text-color has-cyan-bluish-gray-color has-alpha-channel-opacity has-cyan-bluish-gray-background-color has-background is-style-wide\"\/>\n\n\n\n<p><strong>api_key<\/strong> (required)<\/p>\n\n\n\n<p>The API key you have generated on Zealous. Keep it safe, since it gives anyone with it access to your data.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-text-color has-cyan-bluish-gray-color has-alpha-channel-opacity has-cyan-bluish-gray-background-color has-background is-style-wide\"\/>\n\n\n\n<p><strong>opportunity_id <\/strong>(required)<\/p>\n\n\n\n<p>The ID of the opportunity you wish this webhook to listen to.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-text-color has-cyan-bluish-gray-color has-alpha-channel-opacity has-cyan-bluish-gray-background-color has-background is-style-wide\"\/>\n\n\n\n<p><strong>entry_id<\/strong> (optional)<\/p>\n\n\n\n<p>The ID of the entry you wish to load.<\/p>\n<\/div>\n<\/div>\n\n\n\n<div style=\"height:64px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<div class=\"wp-block-columns alignwide is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\">\n<h4 class=\"wp-block-heading\"><strong>Response<\/strong><\/h4>\n\n\n\n<p>Returns the Submission object belonging to the <strong>opportunity_id<\/strong>. <\/p>\n\n\n\n<p>This includes: <\/p>\n\n\n\n<div id=\"wp-block-themeisle-blocks-accordion-28bcb5fd\" data-has-schema=\"false\" class=\"wp-block-themeisle-blocks-accordion icon-first\">\n<details class=\"wp-block-themeisle-blocks-accordion-item\"><summary class=\"wp-block-themeisle-blocks-accordion-item__title\"><div><strong>Action <\/strong>(action&#8230;)<\/div><\/summary><div class=\"wp-block-themeisle-blocks-accordion-item__content\">\n<p>Details action that was undertaken on an entry. This includes when the action happened and who actioned it.<\/p>\n\n\n\n<p>Zealous publishes the following actions to the webhook currently:<\/p>\n\n\n\n<hr class=\"wp-block-separator has-text-color has-cyan-bluish-gray-color has-alpha-channel-opacity has-cyan-bluish-gray-background-color has-background is-style-wide\"\/>\n\n\n\n<p><strong>moved to round<\/strong><\/p>\n\n\n\n<p>when an entry is moved to another round by an admin.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-text-color has-cyan-bluish-gray-color has-alpha-channel-opacity has-cyan-bluish-gray-background-color has-background is-style-wide\"\/>\n\n\n\n<p><strong>declined in round<\/strong><\/p>\n\n\n\n<p>when an entry is declined in the round by an admin.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-text-color has-cyan-bluish-gray-color has-alpha-channel-opacity has-cyan-bluish-gray-background-color has-background is-style-wide\"\/>\n\n\n\n<p><strong>removed<\/strong><\/p>\n\n\n\n<p>when an entry is removed by an admin.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-text-color has-cyan-bluish-gray-color has-alpha-channel-opacity has-cyan-bluish-gray-background-color has-background is-style-wide\"\/>\n\n\n\n<p><strong>dropped out<\/strong> <\/p>\n\n\n\n<p>when the candidate removed their own submission from your opportunity.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-text-color has-cyan-bluish-gray-color has-alpha-channel-opacity has-cyan-bluish-gray-background-color has-background is-style-wide\"\/>\n<\/div><\/details>\n\n\n\n<details class=\"wp-block-themeisle-blocks-accordion-item\"><summary class=\"wp-block-themeisle-blocks-accordion-item__title\"><div><strong>Submission<\/strong> (submission_&#8230;)<\/div><\/summary><div class=\"wp-block-themeisle-blocks-accordion-item__content\">\n<p>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 <strong>submission_<\/strong><\/p>\n<\/div><\/details>\n\n\n\n<details class=\"wp-block-themeisle-blocks-accordion-item\"><summary class=\"wp-block-themeisle-blocks-accordion-item__title\"><div><strong>Candidate<\/strong> (candidate_&#8230;)<\/div><\/summary><div class=\"wp-block-themeisle-blocks-accordion-item__content\">\n<p>Key data relating to the candidate who&#8217;s submission status changed. This includes name, email, ids and more. All data linked to the submission object starts with <strong>candidate_<\/strong><\/p>\n<\/div><\/details>\n\n\n\n<details class=\"wp-block-themeisle-blocks-accordion-item\"><summary class=\"wp-block-themeisle-blocks-accordion-item__title\"><div><strong>Payment Details<\/strong> (&#8220;payment&#8221;:)<\/div><\/summary><div class=\"wp-block-themeisle-blocks-accordion-item__content\">\n<p>If you take a payment, the <strong>&#8220;payment:&#8221;<\/strong> object will also be provided with details such as amount, currency, tax breakdown etc.<\/p>\n<\/div><\/details>\n<\/div>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\">\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-json\" data-file=\"JSON Response\" data-lang=\"JSON\" data-show-lang=\"1\"><code>{\n  &quot;opportunity_id&quot;: &quot;MnXZOXXXXXXXXXXXXXXX&quot;,\n  &quot;opportunity_name&quot;: &quot;Incredible Awards&quot;,\t\n\n  &quot;action&quot;: &quot;moved to round&quot;,\n  &quot;actioned_by_name&quot;: &quot;Jane Chen&quot;,\n  &quot;actioned_by_id&quot;: &quot;he5UxOdXXXXXXXXXXXXX&quot;,\n  &quot;actioned_on&quot;: &quot;2023-10-23T15:49:23+0000&quot;,\n\t\n  &quot;submission_id&quot;: &quot;njTvtzXXXXXXXXXXXXXX&quot;,\n  &quot;submission_short_id&quot;: &quot;AA001&quot;,\n  &quot;submission_status&quot;: &quot;Round 1&quot;,\n  &quot;submission_category &quot;: &quot;Category A&quot;,\n  &quot;submission_url&quot;: &quot;https:\/\/zealous.co\/entry\/opportunity\/0\/candidate\/entry\/?..&quot;,\n\n  &quot;candidate_id&quot;: &quot;fFAuHjXXXXXXXXXXXXXX&quot;,\n  &quot;candidate_email&quot;: &quot;candidate@example.com&quot;,\n  &quot;candidate_firstname&quot;: &quot;Guy&quot;,\n  &quot;candidate_surname&quot;: &quot;Armitage&quot;,\n  &quot;candidate_url&quot;: &quot;https:\/\/zealous.co\/guy\/portfolio\/&quot;\n\n  }<\/code><\/pre><\/div>\n<\/div>\n<\/div>\n","protected":false},"excerpt":{"rendered":"<p>A breakdown of the data returned to you through the Zealous API when an entry&#8217;s status is changed (e.g. sent to a round).<\/p>\n","protected":false},"author":3,"featured_media":0,"parent":12084,"menu_order":4,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-12234","docs","type-docs","status-publish","hentry","no-post-thumbnail"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/docs\/12234","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/comments?post=12234"}],"version-history":[{"count":0,"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/docs\/12234\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/docs\/12084"}],"wp:attachment":[{"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/media?parent=12234"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/doc_tag?post=12234"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}