{ "openapi": "3.1.0", "info": { "title": "Spott Webhooks", "version": "1.0.0" }, "tags": [ { "name": "Candidates" }, { "name": "Applications" }, { "name": "Jobs" }, { "name": "Job descriptions" }, { "name": "Job board postings" }, { "name": "Companies" }, { "name": "Placements" }, { "name": "Notes" }, { "name": "Users" }, { "name": "Signing requests" }, { "name": "Attachments" }, { "name": "Candidate portal" }, { "name": "Opportunities" } ], "webhooks": { "placement.created": { "post": { "summary": "A new placement has been created", "operationId": "placement.created", "tags": ["Placements"], "x-mint": { "href": "/docs/developers/webhooks/placement-created" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "placement.created", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The placement ID" }, "application": { "type": "object", "properties": { "id": { "type": "string", "description": "The application ID" } }, "required": ["id"], "additionalProperties": false, "description": "The application the placement was made for" } }, "required": ["event", "id", "application"], "additionalProperties": false, "description": "Payload emitted when a placement is created" } } } } } }, "placement.updated": { "post": { "summary": "A placement has been updated", "operationId": "placement.updated", "tags": ["Placements"], "x-mint": { "href": "/docs/developers/webhooks/placement-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "placement.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The placement ID" }, "application": { "type": "object", "properties": { "id": { "type": "string", "description": "The application ID" } }, "required": ["id"], "additionalProperties": false, "description": "The application the placement was made for" } }, "required": ["event", "id", "application"], "additionalProperties": false, "description": "Payload for placement.updated webhook event" } } } } } }, "placement.deleted": { "post": { "summary": "A placement has been deleted", "operationId": "placement.deleted", "tags": ["Placements"], "x-mint": { "href": "/docs/developers/webhooks/placement-deleted" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "placement.deleted", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The placement ID" }, "application": { "type": "object", "properties": { "id": { "type": "string", "description": "The application ID" } }, "required": ["id"], "additionalProperties": false, "description": "The application the placement was made for" } }, "required": ["event", "id", "application"], "additionalProperties": false, "description": "Payload for placement.deleted webhook event" } } } } } }, "candidate.created": { "post": { "summary": "A new candidate has been created", "operationId": "candidate.created", "tags": ["Candidates"], "x-mint": { "href": "/docs/developers/webhooks/candidate-created" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "candidate.created", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The candidate ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for candidate.created webhook event" } } } } } }, "candidate.updated": { "post": { "summary": "A candidate has been updated", "operationId": "candidate.updated", "tags": ["Candidates"], "x-mint": { "href": "/docs/developers/webhooks/candidate-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "candidate.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The candidate ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for candidate.updated webhook event" } } } } } }, "candidate.deleted": { "post": { "summary": "A candidate has been deleted", "operationId": "candidate.deleted", "tags": ["Candidates"], "x-mint": { "href": "/docs/developers/webhooks/candidate-deleted" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "candidate.deleted", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The candidate ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for candidate.deleted webhook event" } } } } } }, "candidate.merged": { "post": { "summary": "Two candidates have been merged", "operationId": "candidate.merged", "tags": ["Candidates"], "x-mint": { "href": "/docs/developers/webhooks/candidate-merged" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "candidate.merged", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "target": { "type": "object", "properties": { "candidate": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the target (surviving) candidate" } }, "required": ["id"], "additionalProperties": false } }, "required": ["candidate"], "additionalProperties": false }, "source": { "type": "object", "properties": { "candidate": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the source (merged and deleted) candidate" } }, "required": ["id"], "additionalProperties": false } }, "required": ["candidate"], "additionalProperties": false } }, "required": ["event", "target", "source"], "additionalProperties": false, "description": "Payload for candidate.merged webhook event" } } } } } }, "candidate.contactInformation.updated": { "post": { "summary": "A candidate's contact information has been updated", "operationId": "candidate.contactInformation.updated", "tags": ["Candidates"], "x-mint": { "href": "/docs/developers/webhooks/candidate-contactinformation-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "candidate.contactInformation.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The candidate ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for candidate.contactInformation.updated webhook event" } } } } } }, "candidate.workExperiences.updated": { "post": { "summary": "A candidate's work experiences have been updated", "operationId": "candidate.workExperiences.updated", "tags": ["Candidates"], "x-mint": { "href": "/docs/developers/webhooks/candidate-workexperiences-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "candidate.workExperiences.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The candidate ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for candidate.workExperiences.updated webhook event" } } } } } }, "candidate.education.updated": { "post": { "summary": "A candidate's education has been updated", "operationId": "candidate.education.updated", "tags": ["Candidates"], "x-mint": { "href": "/docs/developers/webhooks/candidate-education-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "candidate.education.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The candidate ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for candidate.education.updated webhook event" } } } } } }, "candidate.certifications.updated": { "post": { "summary": "A candidate's certifications have been updated", "operationId": "candidate.certifications.updated", "tags": ["Candidates"], "x-mint": { "href": "/docs/developers/webhooks/candidate-certifications-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "candidate.certifications.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The candidate ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for candidate.certifications.updated webhook event" } } } } } }, "vacancy.created": { "post": { "summary": "A new job has been created", "operationId": "vacancy.created", "tags": ["Jobs"], "x-mint": { "href": "/docs/developers/webhooks/vacancy-created" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "vacancy.created", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The job ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for vacancy.created webhook event" } } } } } }, "vacancy.updated": { "post": { "summary": "A job has been updated", "operationId": "vacancy.updated", "tags": ["Jobs"], "x-mint": { "href": "/docs/developers/webhooks/vacancy-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "vacancy.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The job ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for vacancy.updated webhook event" } } } } } }, "vacancy.deleted": { "post": { "summary": "A job has been deleted", "operationId": "vacancy.deleted", "tags": ["Jobs"], "x-mint": { "href": "/docs/developers/webhooks/vacancy-deleted" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "vacancy.deleted", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The job ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for vacancy.deleted webhook event" } } } } } }, "vacancy.merged": { "post": { "summary": "Two jobs have been merged", "operationId": "vacancy.merged", "tags": ["Jobs"], "x-mint": { "href": "/docs/developers/webhooks/vacancy-merged" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "vacancy.merged", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "target": { "type": "object", "properties": { "vacancy": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the target (surviving) job" } }, "required": ["id"], "additionalProperties": false } }, "required": ["vacancy"], "additionalProperties": false }, "source": { "type": "object", "properties": { "vacancy": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the source (merged and deleted) job" } }, "required": ["id"], "additionalProperties": false } }, "required": ["vacancy"], "additionalProperties": false } }, "required": ["event", "target", "source"], "additionalProperties": false, "description": "Payload for vacancy.merged webhook event" } } } } } }, "vacancy.stage.moved": { "post": { "summary": "A job has been moved to a different stage", "operationId": "vacancy.stage.moved", "tags": ["Jobs"], "x-mint": { "href": "/docs/developers/webhooks/vacancy-stage-moved" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "vacancy.stage.moved", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The job ID" }, "stage": { "type": "object", "properties": { "to": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the new stage" } }, "required": ["id"], "additionalProperties": false } }, "required": ["to"], "additionalProperties": false } }, "required": ["event", "id", "stage"], "additionalProperties": false, "description": "Payload for vacancy.stage.moved webhook event" } } } } } }, "jobDescription.created": { "post": { "summary": "A new job description has been created", "operationId": "jobDescription.created", "tags": ["Job descriptions"], "x-mint": { "href": "/docs/developers/webhooks/jobdescription-created" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "jobDescription.created", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The job description ID" }, "vacancyId": { "type": "string", "description": "The ID of the job it belongs to" } }, "required": ["event", "id", "vacancyId"], "additionalProperties": false, "description": "Payload for jobDescription.created webhook event" } } } } } }, "jobDescription.updated": { "post": { "summary": "A job description has been updated", "operationId": "jobDescription.updated", "tags": ["Job descriptions"], "x-mint": { "href": "/docs/developers/webhooks/jobdescription-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "jobDescription.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The job description ID" }, "vacancyId": { "type": "string", "description": "The ID of the job it belongs to" } }, "required": ["event", "id", "vacancyId"], "additionalProperties": false, "description": "Payload for jobDescription.updated webhook event" } } } } } }, "jobDescription.deleted": { "post": { "summary": "A job description has been deleted", "operationId": "jobDescription.deleted", "tags": ["Job descriptions"], "x-mint": { "href": "/docs/developers/webhooks/jobdescription-deleted" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "jobDescription.deleted", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The job description ID" }, "vacancyId": { "type": "string", "description": "The ID of the job it belonged to" } }, "required": ["event", "id", "vacancyId"], "additionalProperties": false, "description": "Payload for jobDescription.deleted webhook event" } } } } } }, "jobBoardPosting.created": { "post": { "summary": "A new job board posting has been created", "operationId": "jobBoardPosting.created", "tags": ["Job board postings"], "x-mint": { "href": "/docs/developers/webhooks/jobboardposting-created" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "jobBoardPosting.created", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The job board posting ID" }, "vacancyId": { "description": "The vacancy ID", "type": ["string", "null"] } }, "required": ["event", "id", "vacancyId"], "additionalProperties": false, "description": "Payload for jobBoardPosting.created webhook event" } } } } } }, "jobBoardPosting.updated": { "post": { "summary": "A job board posting has been updated", "operationId": "jobBoardPosting.updated", "tags": ["Job board postings"], "x-mint": { "href": "/docs/developers/webhooks/jobboardposting-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "jobBoardPosting.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The job board posting ID" }, "vacancyId": { "description": "The vacancy ID", "type": ["string", "null"] } }, "required": ["event", "id", "vacancyId"], "additionalProperties": false, "description": "Payload for jobBoardPosting.updated webhook event" } } } } } }, "jobBoardPosting.deleted": { "post": { "summary": "A job board posting has been deleted", "operationId": "jobBoardPosting.deleted", "tags": ["Job board postings"], "x-mint": { "href": "/docs/developers/webhooks/jobboardposting-deleted" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "jobBoardPosting.deleted", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The job board posting ID" }, "vacancyId": { "description": "The vacancy ID", "type": ["string", "null"] } }, "required": ["event", "id", "vacancyId"], "additionalProperties": false, "description": "Payload for jobBoardPosting.deleted webhook event" } } } } } }, "application.created": { "post": { "summary": "A new application has been created", "operationId": "application.created", "tags": ["Applications"], "x-mint": { "href": "/docs/developers/webhooks/application-created" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "application.created", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The application ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for application.created webhook event" } } } } } }, "application.updated": { "post": { "summary": "An application has been updated", "operationId": "application.updated", "tags": ["Applications"], "x-mint": { "href": "/docs/developers/webhooks/application-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "application.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The application ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for application.updated webhook event" } } } } } }, "application.deleted": { "post": { "summary": "An application has been deleted", "operationId": "application.deleted", "tags": ["Applications"], "x-mint": { "href": "/docs/developers/webhooks/application-deleted" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "application.deleted", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The application ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for application.deleted webhook event" } } } } } }, "application.stage.moved": { "post": { "summary": "An application has been moved to a different stage", "operationId": "application.stage.moved", "tags": ["Applications"], "x-mint": { "href": "/docs/developers/webhooks/application-stage-moved" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "application.stage.moved", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The application ID" }, "stage": { "type": "object", "properties": { "to": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the new stage" } }, "required": ["id"], "additionalProperties": false } }, "required": ["to"], "additionalProperties": false } }, "required": ["event", "id", "stage"], "additionalProperties": false, "description": "Payload for application.stage.moved webhook event" } } } } } }, "application.rejection.created": { "post": { "summary": "A rejection has been created for an application", "operationId": "application.rejection.created", "tags": ["Applications"], "x-mint": { "href": "/docs/developers/webhooks/application-rejection-created" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "application.rejection.created", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "application": { "type": "object", "properties": { "id": { "type": "string", "description": "The application ID" } }, "required": ["id"], "additionalProperties": false }, "rejection": { "type": "object", "properties": { "id": { "type": "string", "description": "The rejection ID" } }, "required": ["id"], "additionalProperties": false } }, "required": ["event", "application", "rejection"], "additionalProperties": false, "description": "Payload for application.rejection.created webhook event" } } } } } }, "opportunity.created": { "post": { "summary": "A new opportunity has been created", "operationId": "opportunity.created", "tags": ["Opportunities"], "x-mint": { "href": "/docs/developers/webhooks/opportunity-created" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "opportunity.created", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The opportunity ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for opportunity.created webhook event" } } } } } }, "opportunity.updated": { "post": { "summary": "An opportunity has been updated", "operationId": "opportunity.updated", "tags": ["Opportunities"], "x-mint": { "href": "/docs/developers/webhooks/opportunity-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "opportunity.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The opportunity ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for opportunity.updated webhook event" } } } } } }, "opportunity.deleted": { "post": { "summary": "An opportunity has been deleted", "operationId": "opportunity.deleted", "tags": ["Opportunities"], "x-mint": { "href": "/docs/developers/webhooks/opportunity-deleted" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "opportunity.deleted", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The opportunity ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for opportunity.deleted webhook event" } } } } } }, "opportunity.stage.moved": { "post": { "summary": "An opportunity has been moved to a different stage", "operationId": "opportunity.stage.moved", "tags": ["Opportunities"], "x-mint": { "href": "/docs/developers/webhooks/opportunity-stage-moved" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "opportunity.stage.moved", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The opportunity ID" }, "stage": { "type": "object", "properties": { "to": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the new stage" } }, "required": ["id"], "additionalProperties": false } }, "required": ["to"], "additionalProperties": false } }, "required": ["event", "id", "stage"], "additionalProperties": false, "description": "Payload for opportunity.stage.moved webhook event" } } } } } }, "note.created": { "post": { "summary": "A new note has been created", "operationId": "note.created", "tags": ["Notes"], "x-mint": { "href": "/docs/developers/webhooks/note-created" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "note.created", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The note ID" }, "links": { "type": "object", "properties": { "candidates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Candidates linked to the note" }, "clientContacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Client contacts linked to the note" }, "clients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Companies linked to the note" }, "vacancies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Jobs linked to the note" }, "applications": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Applications linked to the note" }, "interviews": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Interviews linked to the note" }, "opportunities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Opportunities linked to the note" } }, "required": [ "candidates", "clientContacts", "clients", "vacancies", "applications", "interviews", "opportunities" ], "additionalProperties": false } }, "required": ["event", "id", "links"], "additionalProperties": false, "description": "Payload for note.created webhook event" } } } } } }, "note.updated": { "post": { "summary": "A note has been updated", "operationId": "note.updated", "tags": ["Notes"], "x-mint": { "href": "/docs/developers/webhooks/note-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "note.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The note ID" }, "links": { "type": "object", "properties": { "candidates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Candidates linked to the note" }, "clientContacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Client contacts linked to the note" }, "clients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Companies linked to the note" }, "vacancies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Jobs linked to the note" }, "applications": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Applications linked to the note" }, "interviews": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Interviews linked to the note" }, "opportunities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Opportunities linked to the note" } }, "required": [ "candidates", "clientContacts", "clients", "vacancies", "applications", "interviews", "opportunities" ], "additionalProperties": false } }, "required": ["event", "id", "links"], "additionalProperties": false, "description": "Payload for note.updated webhook event" } } } } } }, "note.deleted": { "post": { "summary": "A note has been deleted", "operationId": "note.deleted", "tags": ["Notes"], "x-mint": { "href": "/docs/developers/webhooks/note-deleted" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "note.deleted", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The note ID" }, "links": { "type": "object", "properties": { "candidates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Candidates linked to the note" }, "clientContacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Client contacts linked to the note" }, "clients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Companies linked to the note" }, "vacancies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Jobs linked to the note" }, "applications": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Applications linked to the note" }, "interviews": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Interviews linked to the note" }, "opportunities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Opportunities linked to the note" } }, "required": [ "candidates", "clientContacts", "clients", "vacancies", "applications", "interviews", "opportunities" ], "additionalProperties": false } }, "required": ["event", "id", "links"], "additionalProperties": false, "description": "Payload for note.deleted webhook event" } } } } } }, "user.created": { "post": { "summary": "A new user has been created", "operationId": "user.created", "tags": ["Users"], "x-mint": { "href": "/docs/developers/webhooks/user-created" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "user.created", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The user ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for user.created webhook event" } } } } } }, "user.invited": { "post": { "summary": "A user has been invited", "operationId": "user.invited", "tags": ["Users"], "x-mint": { "href": "/docs/developers/webhooks/user-invited" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "user.invited", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "invitation": { "type": "object", "properties": { "id": { "type": "string", "description": "The invitation ID" } }, "required": ["id"], "additionalProperties": false }, "user": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$", "description": "The invited user email address" } }, "required": ["email"], "additionalProperties": false } }, "required": ["event", "invitation", "user"], "additionalProperties": false, "description": "Payload for user.invited webhook event" } } } } } }, "user.updated": { "post": { "summary": "A user has been updated", "operationId": "user.updated", "tags": ["Users"], "x-mint": { "href": "/docs/developers/webhooks/user-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "user.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The user ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for user.updated webhook event" } } } } } }, "user.deactivated": { "post": { "summary": "A user has been deactivated", "operationId": "user.deactivated", "tags": ["Users"], "x-mint": { "href": "/docs/developers/webhooks/user-deactivated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "user.deactivated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The user ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for user.deactivated webhook event" } } } } } }, "client.created": { "post": { "summary": "A new client has been created", "operationId": "client.created", "tags": ["Companies"], "x-mint": { "href": "/docs/developers/webhooks/client-created" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "client.created", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The company ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for client.created webhook event" } } } } } }, "client.updated": { "post": { "summary": "A client has been updated", "operationId": "client.updated", "tags": ["Companies"], "x-mint": { "href": "/docs/developers/webhooks/client-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "client.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The company ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for client.updated webhook event" } } } } } }, "client.deleted": { "post": { "summary": "A client has been deleted", "operationId": "client.deleted", "tags": ["Companies"], "x-mint": { "href": "/docs/developers/webhooks/client-deleted" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "client.deleted", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The company ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for client.deleted webhook event" } } } } } }, "client.merged": { "post": { "summary": "Two clients have been merged", "operationId": "client.merged", "tags": ["Companies"], "x-mint": { "href": "/docs/developers/webhooks/client-merged" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "client.merged", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "target": { "type": "object", "properties": { "client": { "type": "object", "properties": { "companyId": { "type": "string", "description": "The company ID of the target (surviving) client" } }, "required": ["companyId"], "additionalProperties": false } }, "required": ["client"], "additionalProperties": false }, "source": { "type": "object", "properties": { "client": { "type": "object", "properties": { "companyId": { "type": "string", "description": "The company ID of the source (merged and deleted) client" } }, "required": ["companyId"], "additionalProperties": false } }, "required": ["client"], "additionalProperties": false } }, "required": ["event", "target", "source"], "additionalProperties": false, "description": "Payload for client.merged webhook event" } } } } } }, "client.hierarchy.updated": { "post": { "summary": "A client hierarchy has been updated", "operationId": "client.hierarchy.updated", "tags": ["Companies"], "x-mint": { "href": "/docs/developers/webhooks/client-hierarchy-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "client.hierarchy.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The client hierarchy ID" } }, "required": ["event", "id"], "additionalProperties": false, "description": "Payload for client.hierarchy.updated webhook event" } } } } } }, "signingRequest.created": { "post": { "summary": "A signing request has been created", "operationId": "signingRequest.created", "tags": ["Signing requests"], "x-mint": { "href": "/docs/developers/webhooks/signingrequest-created", "metadata": { "sidebarTitle": "Signing Request created" } }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "signingRequest.created", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "signingRequest": { "type": "object", "properties": { "id": { "type": "string", "description": "The signing request ID" } }, "required": ["id"], "additionalProperties": false } }, "required": ["event", "signingRequest"], "additionalProperties": false, "description": "Payload for signingRequest.created webhook event" } } } } } }, "signingRequest.completed": { "post": { "summary": "A signing request has been completed", "operationId": "signingRequest.completed", "tags": ["Signing requests"], "x-mint": { "href": "/docs/developers/webhooks/signingrequest-completed", "metadata": { "sidebarTitle": "Signing Request completed" } }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "signingRequest.completed", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "signingRequest": { "type": "object", "properties": { "id": { "type": "string", "description": "The signing request ID" } }, "required": ["id"], "additionalProperties": false } }, "required": ["event", "signingRequest"], "additionalProperties": false, "description": "Payload for signingRequest.completed webhook event" } } } } } }, "attachment.created": { "post": { "summary": "A new attachment has been created", "operationId": "attachment.created", "tags": ["Attachments"], "x-mint": { "href": "/docs/developers/webhooks/attachment-created" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "attachment.created", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The attachment ID" }, "links": { "type": "object", "properties": { "candidates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Candidates the attachment is linked to" }, "clientContacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Client contacts the attachment is linked to" }, "clients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Companies the attachment is linked to" }, "vacancies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Jobs the attachment is linked to" }, "opportunities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Opportunities the attachment is linked to" }, "placements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Placements the attachment is linked to" }, "applications": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Applications the attachment is linked to" }, "clientPortals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Client portals the attachment is linked to" } }, "required": [ "candidates", "clientContacts", "clients", "vacancies", "opportunities", "placements", "applications", "clientPortals" ], "additionalProperties": false } }, "required": ["event", "id", "links"], "additionalProperties": false, "description": "Payload for attachment.created webhook event" } } } } } }, "attachment.updated": { "post": { "summary": "An attachment has been updated", "operationId": "attachment.updated", "tags": ["Attachments"], "x-mint": { "href": "/docs/developers/webhooks/attachment-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "attachment.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The attachment ID" }, "links": { "type": "object", "properties": { "candidates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Candidates the attachment is linked to" }, "clientContacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Client contacts the attachment is linked to" }, "clients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Companies the attachment is linked to" }, "vacancies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Jobs the attachment is linked to" }, "opportunities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Opportunities the attachment is linked to" }, "placements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Placements the attachment is linked to" }, "applications": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Applications the attachment is linked to" }, "clientPortals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Client portals the attachment is linked to" } }, "required": [ "candidates", "clientContacts", "clients", "vacancies", "opportunities", "placements", "applications", "clientPortals" ], "additionalProperties": false } }, "required": ["event", "id", "links"], "additionalProperties": false, "description": "Payload for attachment.updated webhook event" } } } } } }, "attachment.deleted": { "post": { "summary": "An attachment has been deleted", "operationId": "attachment.deleted", "tags": ["Attachments"], "x-mint": { "href": "/docs/developers/webhooks/attachment-deleted" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "attachment.deleted", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The attachment ID" }, "links": { "type": "object", "properties": { "candidates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Candidates the attachment is linked to" }, "clientContacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Client contacts the attachment is linked to" }, "clients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Companies the attachment is linked to" }, "vacancies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Jobs the attachment is linked to" }, "opportunities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Opportunities the attachment is linked to" }, "placements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Placements the attachment is linked to" }, "applications": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Applications the attachment is linked to" }, "clientPortals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The linked entity ID" } }, "required": ["id"], "additionalProperties": false }, "description": "Client portals the attachment is linked to" } }, "required": [ "candidates", "clientContacts", "clients", "vacancies", "opportunities", "placements", "applications", "clientPortals" ], "additionalProperties": false } }, "required": ["event", "id", "links"], "additionalProperties": false, "description": "Payload for attachment.deleted webhook event" } } } } } }, "appointment.created": { "post": { "summary": "An appointment has been planned for a candidate", "operationId": "appointment.created", "tags": ["Candidate portal"], "x-mint": { "href": "/docs/developers/webhooks/appointment-created" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "appointment.created", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The appointment ID" }, "candidateId": { "type": "string", "description": "The ID of the candidate the appointment is for" } }, "required": ["event", "id", "candidateId"], "additionalProperties": false, "description": "Payload for appointment.created webhook event" } } } } } }, "appointment.updated": { "post": { "summary": "An appointment of a candidate has been updated", "operationId": "appointment.updated", "tags": ["Candidate portal"], "x-mint": { "href": "/docs/developers/webhooks/appointment-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "appointment.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The appointment ID" }, "candidateId": { "type": "string", "description": "The ID of the candidate the appointment is for" } }, "required": ["event", "id", "candidateId"], "additionalProperties": false, "description": "Payload for appointment.updated webhook event" } } } } } }, "appointment.deleted": { "post": { "summary": "An appointment of a candidate has been deleted", "operationId": "appointment.deleted", "tags": ["Candidate portal"], "x-mint": { "href": "/docs/developers/webhooks/appointment-deleted" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "appointment.deleted", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The appointment ID" }, "candidateId": { "type": "string", "description": "The ID of the candidate the appointment was for" } }, "required": ["event", "id", "candidateId"], "additionalProperties": false, "description": "Payload for appointment.deleted webhook event" } } } } } }, "candidateTodo.created": { "post": { "summary": "A to-do has been assigned to a candidate", "operationId": "candidateTodo.created", "tags": ["Candidate portal"], "x-mint": { "href": "/docs/developers/webhooks/candidatetodo-created" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "candidateTodo.created", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The to-do ID" }, "candidateId": { "type": "string", "description": "The ID of the candidate the to-do is assigned to" } }, "required": ["event", "id", "candidateId"], "additionalProperties": false, "description": "Payload for candidateTodo.created webhook event" } } } } } }, "candidateTodo.updated": { "post": { "summary": "A to-do of a candidate has been updated", "operationId": "candidateTodo.updated", "tags": ["Candidate portal"], "x-mint": { "href": "/docs/developers/webhooks/candidatetodo-updated" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "candidateTodo.updated", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The to-do ID" }, "candidateId": { "type": "string", "description": "The ID of the candidate the to-do is assigned to" } }, "required": ["event", "id", "candidateId"], "additionalProperties": false, "description": "Payload for candidateTodo.updated webhook event" } } } } } }, "candidateTodo.deleted": { "post": { "summary": "A to-do of a candidate has been deleted", "operationId": "candidateTodo.deleted", "tags": ["Candidate portal"], "x-mint": { "href": "/docs/developers/webhooks/candidatetodo-deleted" }, "requestBody": { "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "event": { "type": "object", "properties": { "name": { "type": "string", "const": "candidateTodo.deleted", "description": "The webhook event name" } }, "required": ["name"], "additionalProperties": false }, "id": { "type": "string", "description": "The to-do ID" }, "candidateId": { "type": "string", "description": "The ID of the candidate the to-do was assigned to" } }, "required": ["event", "id", "candidateId"], "additionalProperties": false, "description": "Payload for candidateTodo.deleted webhook event" } } } } } } } }