{"id":12086,"date":"2023-09-19T14:54:52","date_gmt":"2023-09-19T14:54:52","guid":{"rendered":"https:\/\/zealous.co\/help\/docs\/zealous-api\/new-submission\/"},"modified":"2023-12-11T17:26:51","modified_gmt":"2023-12-11T17:26:51","slug":"new-submission","status":"publish","type":"docs","link":"https:\/\/zealous.co\/help\/docs\/api\/triggers\/new-submission\/","title":{"rendered":"On New Submission"},"content":{"rendered":"\n<p><style>\/*! elementor - v3.14.0 - 26-06-2023 *\/<br \/>\n.elementor-heading-title{padding:0;margin:0;line-height:1}.elementor-widget-heading .elementor-heading-title[class*=elementor-size-]>a{color:inherit;font-size:inherit;line-height:inherit}.elementor-widget-heading .elementor-heading-title.elementor-size-small{font-size:15px}.elementor-widget-heading .elementor-heading-title.elementor-size-medium{font-size:19px}.elementor-widget-heading .elementor-heading-title.elementor-size-large{font-size:29px}.elementor-widget-heading .elementor-heading-title.elementor-size-xl{font-size:39px}.elementor-widget-heading .elementor-heading-title.elementor-size-xxl{font-size:59px}<\/style><\/p>\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>Request<\/strong><style>\/*! elementor - v3.14.0 - 26-06-2023 *\/&amp;amp;lt;br \/> .elementor-widget-divider{--divider-border-style:none;--divider-border-width:1px;--divider-color:#0c0d0e;--divider-icon-size:20px;--divider-element-spacing:10px;--divider-pattern-height:24px;--divider-pattern-size:20px;--divider-pattern-url:none;--divider-pattern-repeat:repeat-x}.elementor-widget-divider .elementor-divider{display:flex}.elementor-widget-divider .elementor-divider__text{font-size:15px;line-height:1;max-width:95%}.elementor-widget-divider .elementor-divider__element{margin:0 var(--divider-element-spacing);flex-shrink:0}.elementor-widget-divider .elementor-icon{font-size:var(--divider-icon-size)}.elementor-widget-divider .elementor-divider-separator{display:flex;margin:0;direction:ltr}.elementor-widget-divider--view-line_icon .elementor-divider-separator,.elementor-widget-divider--view-line_text .elementor-divider-separator{align-items:center}.elementor-widget-divider--view-line_icon .elementor-divider-separator:after,.elementor-widget-divider--view-line_icon .elementor-divider-separator:before,.elementor-widget-divider--view-line_text .elementor-divider-separator:after,.elementor-widget-divider--view-line_text .elementor-divider-separator:before{display:block;content:\"\";border-bottom:0;flex-grow:1;border-top:var(--divider-border-width) var(--divider-border-style) var(--divider-color)}.elementor-widget-divider--element-align-left .elementor-divider .elementor-divider-separator>.elementor-divider__svg:first-of-type{flex-grow:0;flex-shrink:100}.elementor-widget-divider--element-align-left .elementor-divider-separator:before{content:none}.elementor-widget-divider--element-align-left .elementor-divider__element{margin-left:0}.elementor-widget-divider--element-align-right .elementor-divider .elementor-divider-separator>.elementor-divider__svg:last-of-type{flex-grow:0;flex-shrink:100}.elementor-widget-divider--element-align-right .elementor-divider-separator:after{content:none}.elementor-widget-divider--element-align-right .elementor-divider__element{margin-right:0}.elementor-widget-divider:not(.elementor-widget-divider--view-line_text):not(.elementor-widget-divider--view-line_icon) .elementor-divider-separator{border-top:var(--divider-border-width) var(--divider-border-style) var(--divider-color)}.elementor-widget-divider--separator-type-pattern{--divider-border-style:none}.elementor-widget-divider--separator-type-pattern.elementor-widget-divider--view-line .elementor-divider-separator,.elementor-widget-divider--separator-type-pattern:not(.elementor-widget-divider--view-line) .elementor-divider-separator:after,.elementor-widget-divider--separator-type-pattern:not(.elementor-widget-divider--view-line) .elementor-divider-separator:before,.elementor-widget-divider--separator-type-pattern:not([class*=elementor-widget-divider--view]) .elementor-divider-separator{width:100%;min-height:var(--divider-pattern-height);-webkit-mask-size:var(--divider-pattern-size) 100%;mask-size:var(--divider-pattern-size) 100%;-webkit-mask-repeat:var(--divider-pattern-repeat);mask-repeat:var(--divider-pattern-repeat);background-color:var(--divider-color);-webkit-mask-image:var(--divider-pattern-url);mask-image:var(--divider-pattern-url)}.elementor-widget-divider--no-spacing{--divider-pattern-size:auto}.elementor-widget-divider--bg-round{--divider-pattern-repeat:round}.rtl .elementor-widget-divider .elementor-divider__text{direction:rtl}.e-con-inner>.elementor-widget-divider,.e-con>.elementor-widget-divider{width:var(--container-widget-width,100%);--flex-grow:var(--container-widget-flex-grow)}<\/style><\/h4>\n\n\n\n<p>Returns the data of any new submissions made to a specific opportunity belonging to your account. <\/p>\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>Submission<\/strong> (submission_&#8230;)<\/div><\/summary><div class=\"wp-block-themeisle-blocks-accordion-item__content\">\n<p>All information relating to the submission, such as key dates, the title, description, unique ids 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>Data relating to the candidate making the submissions such as name, address, email, phone number 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>Added Works<\/strong> (&#8220;works&#8221;:[&#8230;])<\/div><\/summary><div class=\"wp-block-themeisle-blocks-accordion-item__content\">\n<p>A list of objects added to this submission. This could be an upload, embed or text element. Each object contains it&#8217;s own data relating to it. Such as the web address of the upload, the name, id, and dimension&#8217;s of it (if applicable in your process). All data linked to works can be found in the<strong> &#8220;works&#8221; : [&#8230;] <\/strong>list.<\/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;MnXZOY02XXXXXXXXXXXX&quot;,\n\n  &quot;submission_created&quot;: &quot;2023-10-23T15:49:23+0000&quot;,\n  &quot;submission_updated&quot;: &quot;2023-10-23T15:49:23+0000&quot;,\n  &quot;submission_published&quot;: &quot;2023-10-23T15:49:23+0000&quot;,\n  &quot;submission_id&quot;: &quot;njTvtzHKXXXXXXXXXXXX&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;Best Director&quot;,\n\n  &quot;candidate_id&quot;: &quot;fFAuHjrXXXXXXXXXXXXX&quot;,\t\n  &quot;candidate_email&quot;: &quot;candidate@example.com&quot;,\n  &quot;candidate_firstname&quot;: &quot;Jane&quot;,\n  &quot;candidate_surname&quot;: &quot;Kobayashi-Doe&quot;,\n  &quot;candidate_nickname&quot;: &quot;Autumn Myst&quot;,\n  &quot;candidate_role&quot;: &quot;Artist&quot;,\n  &quot;candidate_address_line1&quot;: &quot;652&quot;,\t\n  &quot;candidate_address_line2&quot;: &quot;Greystone Court&quot;,\n  &quot;candidate_address_city&quot;: &quot;Fort Washington&quot;,\n  &quot;candidate_address_postcode&quot;: &quot;MD 20744&quot;,\n  &quot;candidate_address_country&quot;: &quot;United States&quot;,\n  &quot;candidate_phone&quot;: &quot;+1 213 621 0002&quot;,\n  &quot;candidate_url&quot;: &quot;https:\/\/zealous.co\/username\/portfolio\/&quot;,\n\n  &quot;submission_title&quot;: &quot;Hello World&quot;,\n  &quot;submission_description&quot;: &quot;Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse fermentum nec urna non ultrices. Phasellus rutrum consectetur porta.&quot;,\t\n  &quot;submission_field&quot;: &quot;Art&quot;,\n  &quot;submission_url&quot;: &quot;https:\/\/zealous.co\/username\/entry\/opportunity\/candidate\/entry\/...&quot;,\n  &quot;submission_cover_image&quot;: &quot;https:\/\/storage\/...\/cover_image&quot;,\n  &quot;submission_project_id&quot;: &quot;wmWCbvyXXXXXXXXXXXXX&quot;,\t\n  \n  &quot;works&quot;: [\n      {\n        &quot;work_id&quot;: &quot;1KmGRSXXXXXXXXXXXXXX&quot;,\n        &quot;work_name&quot;: &quot;Title of work 1&quot;,\n        &quot;work_content_original&quot;: &quot;https:\/\/storage\/...\/work_1_media_link&quot;,\n        &quot;work_content_thumbnail&quot;: &quot;https:\/\/storage\/...\/work_1_thumbnail_media_link&quot;,\n        &quot;work_is_physical&quot;: &quot;false&quot;,\n        &quot;work_size_unit&quot;: &quot;cm&quot;,\n        &quot;work_size_width&quot;: &quot;30&quot;,\n        &quot;work_size_height&quot;: &quot;30&quot;,\n        &quot;work_size_depth&quot;: &quot;5&quot;,\n        &quot;work_weight_unit&quot;: &quot;kg&quot;,\n        &quot;work_weight&quot;: &quot;1.5&quot;,\n        &quot;work_price&quot;: &quot;300&quot;,\n        &quot;work_description&quot;: &quot;Description of work 1&quot;\n      },\n      {\n        &quot;work_id&quot;: &quot;1KmGRSXXXXXXXXXXXXXX&quot;,\n        &quot;work_name&quot;: &quot;Title of work 2&quot;,\n        &quot;work_content_original&quot;: &quot;https:\/\/storage\/...\/work_2_media_link&quot;,\n        &quot;work_content_thumbnail&quot;: &quot;https:\/\/storage\/...\/work_2_thumbnail_media_link&quot;,\n        &quot;work_is_physical&quot;: &quot;false&quot;,\n        &quot;work_size_unit&quot;: &quot;inches&quot;,\n        &quot;work_size_width&quot;: &quot;12&quot;,\n        &quot;work_size_height&quot;: &quot;2&quot;,\n        &quot;work_size_depth&quot;: &quot;1&quot;,\n        &quot;work_weight_unit&quot;: &quot;pounds&quot;,\n        &quot;work_weight&quot;: &quot;3&quot;,\n        &quot;work_price&quot;: &quot;1200&quot;,\n        &quot;work_description&quot;: &quot;Description of work 2&quot;\n      },\n      ...\n    ],\n\n  &quot;submission_paid&quot;: &quot;true&quot;,\t\n\n  &quot;payment&quot;: {\n      &quot;id&quot;: &quot;he5UxOdXXXXXXXXXXXXX&quot;,\n      &quot;submissions_allowed&quot;: 1,\n      &quot;submissions_made&quot;: 1,\n      &quot;package_id&quot;: &quot;NAlt56RXXXXXXXXXXXXX&quot;,\n      &quot;package_name&quot;: &quot;1&quot;,\n      &quot;currency&quot;: &quot;gbp&quot;,\n      &quot;stripe_fees&quot;: &quot;0.63&quot;,\n      &quot;zealous_fees&quot;: &quot;0.49&quot;,\n      &quot;stripe_transaction_id&quot;: &quot;ch_3Nuf5r2a7XXXXXXXXXXXXXXX&quot;,\n      &quot;status&quot;: &quot;succeeded&quot;,\n      &quot;total_net&quot;: &quot;9.88&quot;,\n      &quot;tax_rate&quot;: &quot;vat 20&quot;,\n      &quot;tax_type&quot;: &quot;EXCLUSIVE&quot;,\n      &quot;tax_value&quot;: &quot;2.2&quot;,\n      &quot;tax_percentage&quot;: &quot;20.0&quot;,\n      &quot;invoice_url&quot;: &quot;https:\/\/pay.stripe.com\/receipts\/invoices\/...&quot;,\n      &quot;total_transferred&quot;: &quot;12.08&quot;,\n      &quot;total_gross&quot;: &quot;13.2&quot;,\n      &quot;method&quot;: &quot;card&quot;\n    }  \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 a new submission is drafted and completed.<\/p>\n","protected":false},"author":3,"featured_media":0,"parent":12084,"menu_order":5,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-12086","docs","type-docs","status-publish","hentry","no-post-thumbnail"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/docs\/12086","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=12086"}],"version-history":[{"count":0,"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/docs\/12086\/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=12086"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/doc_tag?post=12086"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}