--- updatedAt: 2026-05-28T07:23:54.000Z agentTools: projectIndex: https://developers.smartrecruiters.com/llms.txt --- # Subscribe to a webhook. Please be aware that before any event is delivered each subscription needs to be activated. See [subscription activation](subscriptionsactivate-1). We do limit number of subscriptions each subscriber can register. It means that: * individual user can register up to 20 subscriptions * OAuth application can register up to 20 subscriptions on behalf of a single user Alerting email address and callback authentication properties are optional. # OpenAPI definition ````json { "openapi": "3.0.2", "info": { "version": "201914.59", "title": "Webhooks", "contact": { "name": "SmartRecruiters", "url": "https://developers.smartrecruiters.com" } }, "tags": [ { "name": "subscriptions", "description": "Manage your event subscriptions" } ], "paths": { "/subscriptions": { "post": { "summary": "Subscribe to a webhook.", "description": "Please be aware that before any event is delivered each subscription needs to be activated.\n\nSee [subscription activation](subscriptionsactivate-1).\n\nWe do limit number of subscriptions each subscriber can register. It means that:\n\n* individual user can register up to 20 subscriptions\n* OAuth application can register up to 20 subscriptions on behalf of a single user\n\nAlerting email address and callback authentication properties are optional.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionRequest" } } } }, "responses": { "201": { "description": "Webhook subscription created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "400": { "description": "Invalid request query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "With codes:\n* **NO_PERMISSION_TO_MANAGE_WEBHOOKS** when no permission to manage webhook subscriptions\n* **SUBSCRIPTIONS_LIMIT_EXCEEDED** when subscription limit for subscriber is exceeded\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Incorrect subscription data. Provided callback URL is invalid or event name is not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "callbacks": { "onJobCreated": { "$ref": "#/components/callbacks/onJobCreated" }, "onJobUpdated": { "$ref": "#/components/callbacks/onJobUpdated" }, "onJobStatusUpdated": { "$ref": "#/components/callbacks/onJobStatusUpdated" }, "onJobHiringTeamUpdated": { "$ref": "#/components/callbacks/onJobHiringTeamUpdated" }, "onJobAdCreated": { "$ref": "#/components/callbacks/onJobAdCreated" }, "onJobAdUpdated": { "$ref": "#/components/callbacks/onJobAdUpdated" }, "onJobAdPostingsUpdated": { "$ref": "#/components/callbacks/onJobAdPostingsUpdated" }, "onPositionCreated": { "$ref": "#/components/callbacks/onPositionCreated" }, "onPositionUpdated": { "$ref": "#/components/callbacks/onPositionUpdated" }, "onPositionDeleted": { "$ref": "#/components/callbacks/onPositionDeleted" }, "onApplicationCreated": { "$ref": "#/components/callbacks/onApplicationCreated" }, "onApplicationStatusUpdated": { "$ref": "#/components/callbacks/onApplicationStatusUpdated" }, "onApplicationFieldsUpdated": { "$ref": "#/components/callbacks/onApplicationFieldsUpdated" }, "onApplicationOnboardingStatusUpdated": { "$ref": "#/components/callbacks/onApplicationOnboardingStatusUpdated" }, "onApplicationAttachmentCreated": { "$ref": "#/components/callbacks/onApplicationAttachmentCreated" }, "onApplicationSourceUpdated": { "$ref": "#/components/callbacks/onApplicationSourceUpdated" }, "onCandidateCreated": { "$ref": "#/components/callbacks/onCandidateCreated" }, "onCandidateUpdated": { "$ref": "#/components/callbacks/onCandidateUpdated" }, "onCandidateDeleted": { "$ref": "#/components/callbacks/onCandidateDeleted" }, "onOfferCreated": { "$ref": "#/components/callbacks/onOfferCreated" }, "onOfferUpdated": { "$ref": "#/components/callbacks/onOfferUpdated" }, "onOfferApprovalCreated": { "$ref": "#/components/callbacks/onOfferApprovalCreated" }, "onOfferApprovalApproved": { "$ref": "#/components/callbacks/onOfferApprovalApproved" }, "onOfferApprovalRejected": { "$ref": "#/components/callbacks/onOfferApprovalRejected" }, "onOfferApprovalAbandoned": { "$ref": "#/components/callbacks/onOfferApprovalAbandoned" }, "onOfferApprovalStepApproved": { "$ref": "#/components/callbacks/onOfferApprovalStepApproved" }, "onOfferApprovalStepRejected": { "$ref": "#/components/callbacks/onOfferApprovalStepRejected" }, "onOfferApproverSkipped": { "$ref": "#/components/callbacks/onOfferApproverSkipped" }, "onOfferApproverDelegated": { "$ref": "#/components/callbacks/onOfferApproverDelegated" }, "onOfferApprovalCommentCreated": { "$ref": "#/components/callbacks/onOfferApprovalCommentCreated" }, "onJobApprovalCreated": { "$ref": "#/components/callbacks/onJobApprovalCreated" }, "onJobApprovalApproved": { "$ref": "#/components/callbacks/onJobApprovalApproved" }, "onJobApprovalRejected": { "$ref": "#/components/callbacks/onJobApprovalRejected" }, "onJobApprovalAbandoned": { "$ref": "#/components/callbacks/onJobApprovalAbandoned" }, "onJobApprovalStepApproved": { "$ref": "#/components/callbacks/onJobApprovalStepApproved" }, "onJobApprovalStepRejected": { "$ref": "#/components/callbacks/onJobApprovalStepRejected" }, "onJobApproverSkipped": { "$ref": "#/components/callbacks/onJobApproverSkipped" }, "onJobApproverDelegated": { "$ref": "#/components/callbacks/onJobApproverDelegated" }, "onJobApprovalCommentCreated": { "$ref": "#/components/callbacks/onJobApprovalCommentCreated" }, "onReviewCreated": { "$ref": "#/components/callbacks/onReviewCreated" }, "onReviewUpdated": { "$ref": "#/components/callbacks/onReviewUpdated" }, "onReviewDeleted": { "$ref": "#/components/callbacks/onReviewDeleted" }, "onApplicationScreeningAnswersCreated": { "$ref": "#/components/callbacks/onApplicationScreeningAnswersCreated" }, "onApplicationScreeningAnswersUpdated": { "$ref": "#/components/callbacks/onApplicationScreeningAnswersUpdated" }, "onOnboardingProcessStarted": { "$ref": "#/components/callbacks/onOnboardingProcessStarted" }, "onOnboardingAssignmentsHighPriorityCompleted": { "$ref": "#/components/callbacks/onOnboardingAssignmentsHighPriorityCompleted" }, "onOnboardingAssignmentsCompleted": { "$ref": "#/components/callbacks/onOnboardingAssignmentsCompleted" }, "onOnboardingAssignmentIntegrationRelevantCompleted": { "$ref": "#/components/callbacks/onOnboardingAssignmentIntegrationRelevantCompleted" }, "onOnboardingAssignmentsIntegrationRelevantCompleted": { "$ref": "#/components/callbacks/onOnboardingAssignmentsIntegrationRelevantCompleted" }, "onInterviewCreated": { "$ref": "#/components/callbacks/onInterviewCreated" }, "onInterviewUpdated": { "$ref": "#/components/callbacks/onInterviewUpdated" }, "onInterviewCanceled": { "$ref": "#/components/callbacks/onInterviewCanceled" }, "onSelfScheduleCreated": { "$ref": "#/components/callbacks/onSelfScheduleCreated" }, "onWinstonChatVisibilityChanged": { "$ref": "#/components/callbacks/onWinstonChatVisibilityChanged" } }, "operationId": "subscriptions.create", "tags": [ "subscriptions" ], "security": [ { "key": [] }, { "oauth": [ "webhooks_write", "webhooks_manage" ] } ] } } }, "components": { "parameters": { "eventName": { "name": "event-name", "in": "header", "description": "event name", "schema": { "$ref": "#/components/schemas/EventName" }, "required": true }, "eventVersion": { "name": "event-version", "in": "header", "description": "event version", "schema": { "type": "string" }, "required": true }, "eventId": { "name": "event-id", "in": "header", "description": "event id, remains unchanged during consecutive retried callbacks", "schema": { "type": "string" }, "required": true }, "smartrecruitersSignature": { "name": "smartrecruiters-signature", "in": "header", "description": "callback signature see at [Create Signature](#subscriptions/subscriptions.generateSecretKey)", "schema": { "type": "string" }, "required": false }, "smartrecruitersTimestamp": { "name": "smartrecruiters-timestamp", "in": "header", "description": "timestamp of callback signature see at [Create Signature](#subscriptions/subscriptions.generateSecretKey)", "schema": { "type": "number" }, "required": false }, "Link": { "name": "Link", "in": "header", "description": "Link to entity details is provided in the Link header according to [RFC8288](https://tools.ietf.org/html/rfc8288). The relation type is \"self\".", "schema": { "type": "string" }, "required": true } }, "requestBodies": { "JobCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobWebhookPayload" } } } }, "JobAdCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobAdWebhookPayload" } } } }, "JobAdPostingsCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobAdPostingsWebhookPayload" } } } }, "PositionCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PositionWebhookPayload" } } } }, "ApplicationCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationWebhookPayload" } } } }, "ApplicationAttachmentCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationAttachmentWebhookPayload" } } } }, "CandidateCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateWebhookPayload" } } } }, "OfferCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfferWebhookPayload" } } } }, "OfferApprovalCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfferApprovalWebhookPayload" } } } }, "JobApprovalCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobApprovalWebhookPayload" } } } }, "ReviewCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewWebhookPayload" } } } }, "ScreeningQuestionsAnswersCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScreeningQuestionsAnswersWebhookPayload" } } } }, "OnboardingProcessCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardingProcessWebhookPayload" } } } }, "OnboardingHighPriorityAssignmentsCompletedCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardingHighPriorityAssignmentsCompletedWebhookPayload" } } } }, "OnboardingAssignmentsCompletedCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardingAssignmentsCompletedWebhookPayload" } } } }, "IntegrationRelevantAssignmentCompletedCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationRelevantAssignmentCompletedWebhookPayload" } } } }, "AllIntegrationRelevantAssignmentsCompletedCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllIntegrationRelevantAssignmentsCompletedWebhookPayload" } } } }, "InterviewCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterviewWebhookPayload" } } } }, "SelfSchedulingCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelfSchedulingWebhookPayload" } } } }, "WinstonChatCallback": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WinstonChatWebhookPayload" } } } } }, "schemas": { "ErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } }, "Error": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "JobWebhookPayload": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "JobAdWebhookPayload": { "type": "object", "required": [ "job_id", "job_ad_id" ], "properties": { "job_id": { "type": "string" }, "job_ad_id": { "type": "string" } } }, "JobAdPostingsWebhookPayload": { "type": "object", "required": [ "job_id", "job_ad_id" ], "properties": { "job_id": { "type": "string" }, "job_ad_id": { "type": "string" } } }, "PositionWebhookPayload": { "type": "object", "required": [ "job_id", "position_id" ], "properties": { "job_id": { "type": "string" }, "position_id": { "type": "string" } } }, "ApplicationWebhookPayload": { "type": "object", "required": [ "job_id", "candidate_id", "application_id" ], "properties": { "job_id": { "type": "string" }, "candidate_id": { "type": "string" }, "application_id": { "type": "string" } } }, "ApplicationAttachmentWebhookPayload": { "allOf": [ { "$ref": "#/components/schemas/ApplicationWebhookPayload" }, { "type": "object", "required": [ "attachment_id" ], "properties": { "attachment_id": { "type": "string" } } } ] }, "CandidateWebhookPayload": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "OfferWebhookPayload": { "type": "object", "required": [ "job_id", "candidate_id", "offer_id" ], "properties": { "job_id": { "type": "string" }, "candidate_id": { "type": "string" }, "offer_id": { "type": "string" } } }, "OfferApprovalWebhookPayload": { "type": "object", "required": [ "approval_id", "job_id", "candidate_id", "offer_id" ], "properties": { "approval_id": { "type": "string" }, "job_id": { "type": "string" }, "candidate_id": { "type": "string" }, "offer_id": { "type": "string" } } }, "JobApprovalWebhookPayload": { "type": "object", "required": [ "approval_id", "job_id" ], "properties": { "approval_id": { "type": "string" }, "job_id": { "type": "string" } } }, "CallbackUrl": { "type": "string", "format": "https_url", "example": "https://server.com/send/callback/here" }, "EmailAddress": { "type": "string", "format": "email", "example": "webhook.alerts@domain.com" }, "CallbackAuthentication": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/CallbackBasicAuth" }, { "$ref": "#/components/schemas/CallbackHeaderAuth" }, { "$ref": "#/components/schemas/CallbackOAuth2Auth" } ], "example": { "type": "header", "headerName": "X-TOKEN", "headerValue": "J?7HSgUKm7!MPm+EKm^P4BwW4ywRRRVu" } }, "CallbackBasicAuth": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "basic" ] }, "username": { "type": "string" }, "password": { "type": "string" } }, "example": { "type": "basic", "username": "basic-user", "password": "jVG8wzKZ%B+r_NkA" } }, "CallbackHeaderAuth": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "header" ] }, "headerName": { "type": "string", "pattern": "^[Xx]-", "description": "Custom header name starting with \"x-\"" }, "headerValue": { "type": "string" } }, "example": { "type": "header", "username": "token", "password": "J?7HSgUKm7!MPm+EKm^P4BwW4ywRRRVu" } }, "CallbackOAuth2Auth": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "oauth2" ] }, "clientId": { "type": "string", "description": "OAuth2 client ID used for token request" }, "clientSecret": { "type": "string", "description": "OAuth2 client secret used for token request" }, "scope": { "type": "string", "description": "OAuth2 scopes used for token request. If not provided, the token request will not include the scope parameter.\nIf it's provided, the payload of the request to the token service will be extended with `&scope=provided_scope`.\n" }, "tokenServiceUrl": { "type": "string", "format": "https_url", "description": "OAuth2 token service URL. This service is expected to consume `application/x-www-form-urlencoded` content\ntype. The payload will consist of\n\n`client_id=provided_client_id&client_secret=provided_client_secret&grant_type=client_credentials`\n\nIf the scope parameter is defined, then the payload will be extended with `&scope=provided_scope`.\n\nAs a result, the service should return JSON containing information about the access token in the form:\n\n```\n{\n \"access_token\": \"access_token_value\",\n \"expires_in\": 3600\n}\n```\n\nWhere `access_token` is a token value and `expires_in` is a number of seconds until the token expiration.\n" } }, "description": "When `CallbackAuthentication` is set to `oauth2`, every call made to the webhook callback URL will include header\n\n`'authorization': Bearer access_token_value`\n", "example": { "type": "oauth2", "clientId": "oauth_client_123", "clientSecret": "9T{Z8OLl<~Si(=c", "tokenServiceUrl": "https://www.your-token-generator-service.com/tokens" } }, "Subscription": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "callbackUrl": { "$ref": "#/components/schemas/CallbackUrl" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "status": { "type": "string", "readOnly": true, "enum": [ "inactive", "active" ] } }, "required": [ "callbackUrl", "events" ] }, "SubscriptionRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "callbackUrl": { "$ref": "#/components/schemas/CallbackUrl" }, "events": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "$ref": "#/components/schemas/EventName" } }, "alertingEmailAddress": { "$ref": "#/components/schemas/EmailAddress" }, "callbackAuthentication": { "$ref": "#/components/schemas/CallbackAuthentication" } }, "required": [ "callbackUrl", "events" ] }, "Event": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/EventName" }, "version": { "type": "string", "readOnly": true } } }, "EventName": { "type": "string", "enum": [ "job.created", "job.updated", "job.status.updated", "job.hiring-team.updated", "job.ad.created", "job.ad.updated", "job.ad.postings.updated", "position.created", "position.updated", "position.deleted", "application.created", "application.status.updated", "application.fields.updated", "application.onboarding-status.updated", "application.attachment.created", "application.source.updated", "candidate.created", "candidate.updated", "candidate.deleted", "offer.created", "offer.updated", "offer.approval.created", "offer.approval.approved", "offer.approval.rejected", "offer.approval.abandoned", "offer.approval.step.approved", "offer.approval.step.rejected", "offer.approver.skipped", "offer.approver.delegated", "offer.approval.comment.created", "job.approval.created", "job.approval.approved", "job.approval.rejected", "job.approval.abandoned", "job.approval.step.approved", "job.approval.step.rejected", "job.approver.skipped", "job.approver.delegated", "job.approval.comment.created", "review.created", "review.updated", "review.deleted", "application.screening-answers.created", "application.screening-answers.updated", "onboarding.process.started", "onboarding.assignments.high-priority.completed", "onboarding.assignments.completed", "onboarding.assignment.integration-relevant.completed", "onboarding.assignments.integration-relevant.completed", "interview.created", "interview.updated", "interview.canceled", "self-schedule.created", "winston.chat.visibility.changed" ] }, "ReviewWebhookPayload": { "type": "object", "required": [ "application_id", "review_id" ], "properties": { "application_id": { "type": "string" }, "review_id": { "type": "string" } } }, "ScreeningQuestionsAnswersWebhookPayload": { "type": "object", "required": [ "job_id", "candidate_id", "application_id" ], "properties": { "job_id": { "type": "string" }, "candidate_id": { "type": "string" }, "application_id": { "type": "string" } } }, "OnboardingProcessWebhookPayload": { "type": "object", "required": [ "onboarding_process_id", "new_hire_id" ], "properties": { "onboarding_process_id": { "type": "string" }, "new_hire_id": { "type": "string" } } }, "OnboardingHighPriorityAssignmentsCompletedWebhookPayload": { "type": "object", "required": [ "onboarding_process_id", "new_hire_id" ], "properties": { "onboarding_process_id": { "type": "string" }, "new_hire_id": { "type": "string" } } }, "OnboardingAssignmentsCompletedWebhookPayload": { "type": "object", "required": [ "onboarding_process_id", "new_hire_id" ], "properties": { "onboarding_process_id": { "type": "string" }, "new_hire_id": { "type": "string" } } }, "IntegrationRelevantAssignmentCompletedWebhookPayload": { "type": "object", "required": [ "onboarding_process_id", "new_hire_id", "assignment_id", "assignment_type", "integration_key" ], "properties": { "onboarding_process_id": { "type": "string" }, "new_hire_id": { "type": "string" }, "assignment_id": { "type": "string" }, "assignment_type": { "type": "string" }, "integration_key": { "type": "string" } } }, "AllIntegrationRelevantAssignmentsCompletedWebhookPayload": { "type": "object", "required": [ "onboarding_process_id", "new_hire_id" ], "properties": { "onboarding_process_id": { "type": "string" }, "new_hire_id": { "type": "string" } } }, "InterviewWebhookPayload": { "type": "object", "required": [ "interview_id", "candidate_id", "application_id", "company_id" ], "properties": { "interview_id": { "type": "string" }, "candidate_id": { "type": "string" }, "application_id": { "type": "string" }, "company_id": { "type": "string" } } }, "SelfSchedulingWebhookPayload": { "type": "object", "required": [ "self_schedule_id", "candidate_id", "application_id", "job_id", "company_id" ], "properties": { "self_schedule_id": { "type": "string" }, "candidate_id": { "type": "string" }, "application_id": { "type": "string" }, "job_id": { "type": "string" }, "company_id": { "type": "string" } } }, "WinstonChatWebhookPayload": { "type": "object", "required": [ "is_visible", "company_id" ], "properties": { "is_visible": { "type": "boolean" }, "company_id": { "type": "string" } } } }, "responses": { "CallbackAccepted": { "description": "Your server implementation should return this HTTP status code if the data was received successfully.\nWe expect to get the response within 5 seconds. If we don't get a response during this period, we will\nconsider webhook delivery failed.\n" } }, "callbacks": { "onJobCreated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Job created webhook callback", "operationId": "onJobCreatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/JobCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onJobUpdated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Job updated webhook callback", "description": "Events will be triggered when any of the following job properties are changed:\n- `title`\n- `refNumber`\n- `department`\n- `location`\n- `targetHiringDate`\n- `industry`\n- `function`\n- `typeOfEmployment`\n- `experienceLevel`\n- `eooCategory`\n- `template`\n- any of job `properties` value\n", "operationId": "onJobUpdatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/JobCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onJobStatusUpdated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Job status updated webhook callback", "operationId": "onJobStatusUpdatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/JobCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onJobHiringTeamUpdated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Job hiring-team updated webhook callback", "operationId": "onJobHiringTeamUpdatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/JobCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onJobAdCreated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Job ad created webhook callback", "operationId": "onJobAdCreatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/JobAdCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onJobAdUpdated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Job ad updated webhook callback", "operationId": "onJobAdUpdatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/JobAdCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onJobAdPostingsUpdated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Job ad postings updated webhook callback", "operationId": "onJobAdPostingsUpdatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/JobAdPostingsCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onPositionCreated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Position created webhook callback", "operationId": "onPositionCreatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/PositionCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onPositionUpdated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Position updated webhook callback", "operationId": "onPositionUpdatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/PositionCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onPositionDeleted": { "{$request.body#/callbackUrl}": { "post": { "summary": "Position deleted webhook callback", "operationId": "onPositionDeletededCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/PositionCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onApplicationCreated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Application created webhook callback", "operationId": "onApplicationCreatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/ApplicationCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onApplicationStatusUpdated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Application status updated webhook callback", "operationId": "onApplicationStatusUpdatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/ApplicationCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onApplicationFieldsUpdated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Application fields updated webhook callback", "operationId": "onApplicationFieldsUpdatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/ApplicationCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onApplicationOnboardingStatusUpdated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Application onboarding status updated webhook callback", "operationId": "onApplicationOnboardingStatusUpdated", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/ApplicationCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onApplicationAttachmentCreated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Application attachment created webhook callback", "operationId": "onApplicationAttachmentCreated", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/ApplicationAttachmentCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onApplicationSourceUpdated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Application source updated webhook callback", "operationId": "onApplicationSourceUpdatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/ApplicationCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onCandidateCreated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Candidate created webhook callback", "operationId": "onCandidateCreatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/CandidateCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onCandidateUpdated": { "{$request.body#/callbackUrl}": { "post": { "description": "Events will be triggered when any of the following candidate properties is changed:\n- `firstName`\n- `lastName`\n- `email`\n- `phoneNumber`\n- `location`\n- `web`\n- `education`\n- `experience`\n- `internal`\n- `tags`\n", "summary": "Candidate updated webhook callback", "operationId": "onCandidateUpdatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/CandidateCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onCandidateDeleted": { "{$request.body#/callbackUrl}": { "post": { "summary": "Candidate created webhook callback", "operationId": "onCandidateDeletedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/CandidateCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onOfferCreated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Offer created webhook callback", "operationId": "onOfferCreatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/OfferCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onOfferUpdated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Offer updated webhook callback", "operationId": "onOfferUpdatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/OfferCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onOfferApprovalCreated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Created offer approval webhook callback", "operationId": "onOfferApprovalCreatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/OfferApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onOfferApprovalApproved": { "{$request.body#/callbackUrl}": { "post": { "summary": "Approved offer approval webhook callback", "operationId": "onOfferApprovalApprovedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/OfferApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onOfferApprovalRejected": { "{$request.body#/callbackUrl}": { "post": { "summary": "Rejected offer approval webhook callback", "operationId": "onOfferApprovalRejectedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/OfferApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onOfferApprovalAbandoned": { "{$request.body#/callbackUrl}": { "post": { "summary": "Abandoned offer approval webhook callback", "operationId": "onOfferApprovalAbandonedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/OfferApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onOfferApprovalStepApproved": { "{$request.body#/callbackUrl}": { "post": { "summary": "Approved offer approval step webhook callback", "operationId": "onOfferApprovalStepApprovedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/OfferApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onOfferApprovalStepRejected": { "{$request.body#/callbackUrl}": { "post": { "summary": "Rejected offer approval step webhook callback", "operationId": "onOfferApprovalStepRejectedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/OfferApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onOfferApproverSkipped": { "{$request.body#/callbackUrl}": { "post": { "summary": "Skipped offer approver webhook callback", "operationId": "onOfferApproverSkippedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/OfferApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onOfferApproverDelegated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Delegated offer approver webhook callback", "operationId": "onOfferApproverDelegatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/OfferApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onOfferApprovalCommentCreated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Created offer approval comment webhook callback", "operationId": "onOfferApprovalCommentCreatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/OfferApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onJobApprovalCreated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Created job approval webhook callback", "operationId": "onJobApprovalCreatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/JobApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onJobApprovalApproved": { "{$request.body#/callbackUrl}": { "post": { "summary": "Approved job approval webhook callback", "operationId": "onJobApprovalApprovedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/JobApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onJobApprovalRejected": { "{$request.body#/callbackUrl}": { "post": { "summary": "Rejected job approval webhook callback", "operationId": "onJobApprovalRejectedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/JobApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onJobApprovalAbandoned": { "{$request.body#/callbackUrl}": { "post": { "summary": "Abandoned job approval webhook callback", "operationId": "onJobApprovalAbandonedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/JobApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onJobApprovalStepApproved": { "{$request.body#/callbackUrl}": { "post": { "summary": "Approved job approval step webhook callback", "operationId": "onJobApprovalStepApprovedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/JobApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onJobApprovalStepRejected": { "{$request.body#/callbackUrl}": { "post": { "summary": "Rejected job approval step webhook callback", "operationId": "onJobApprovalStepRejectedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/JobApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onJobApproverSkipped": { "{$request.body#/callbackUrl}": { "post": { "summary": "Skipped job approver webhook callback", "operationId": "onJobApproverSkippedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/JobApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onJobApproverDelegated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Delegated job approver webhook callback", "operationId": "onJobApproverDelegatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/JobApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onJobApprovalCommentCreated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Created job approval comment webhook callback", "operationId": "onJobApprovalCommentCreatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/JobApprovalCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onReviewCreated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Review created webhook callback", "operationId": "onReviewCreatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/ReviewCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onReviewUpdated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Review updated webhook callback", "operationId": "onReviewUpdatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/ReviewCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onReviewDeleted": { "{$request.body#/callbackUrl}": { "post": { "summary": "Review deleted webhook callback", "operationId": "onReviewDeletedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/ReviewCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onApplicationScreeningAnswersCreated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Screening answers created", "operationId": "onApplicationScreeningAnswersCreatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/ScreeningQuestionsAnswersCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onApplicationScreeningAnswersUpdated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Screening answers updated", "operationId": "onApplicationScreeningAnswersUpdatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/ScreeningQuestionsAnswersCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onOnboardingProcessStarted": { "{$request.body#/callbackUrl}": { "post": { "summary": "Onboarding process started", "operationId": "onOnboardingProcessStartedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/OnboardingProcessCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onOnboardingAssignmentsHighPriorityCompleted": { "{$request.body#/callbackUrl}": { "post": { "summary": "Onboarding high priority assignments were completed", "operationId": "onOnboardingAssignmentsHighPriorityCompletedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/OnboardingHighPriorityAssignmentsCompletedCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onOnboardingAssignmentsCompleted": { "{$request.body#/callbackUrl}": { "post": { "summary": "Onboarding all assignments were completed", "operationId": "onOnboardingAssignmentsCompletedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/OnboardingAssignmentsCompletedCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onOnboardingAssignmentIntegrationRelevantCompleted": { "{$request.body#/callbackUrl}": { "post": { "summary": "Assignment with an integration key was completed", "operationId": "onOnboardingAssignmentIntegrationRelevantCompletedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/IntegrationRelevantAssignmentCompletedCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onOnboardingAssignmentsIntegrationRelevantCompleted": { "{$request.body#/callbackUrl}": { "post": { "summary": "All assignments that have integration key defined are completed for a particular onboarding process", "operationId": "onOnboardingAssignmentsIntegrationRelevantCompletedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/AllIntegrationRelevantAssignmentsCompletedCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onInterviewCreated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Interview created webhook callback", "operationId": "onInterviewCreatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/InterviewCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onInterviewUpdated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Interview updated webhook callback", "operationId": "onInterviewUpdatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/InterviewCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onInterviewCanceled": { "{$request.body#/callbackUrl}": { "post": { "summary": "Interview canceled webhook callback", "operationId": "onInterviewCanceledCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/InterviewCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onSelfScheduleCreated": { "{$request.body#/callbackUrl}": { "post": { "summary": "Self scheduling created webhook callback", "operationId": "onSelfScheduleCreatedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/SelfSchedulingCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } }, "onWinstonChatVisibilityChanged": { "{$request.body#/callbackUrl}": { "post": { "summary": "Winston chat is now visible or hidden", "operationId": "onWinstonChatVisibilityChangedCallback", "parameters": [ { "$ref": "#/components/parameters/eventName" }, { "$ref": "#/components/parameters/eventVersion" }, { "$ref": "#/components/parameters/eventId" }, { "$ref": "#/components/parameters/Link" }, { "$ref": "#/components/parameters/smartrecruitersSignature" }, { "$ref": "#/components/parameters/smartrecruitersTimestamp" } ], "requestBody": { "$ref": "#/components/requestBodies/WinstonChatCallback" }, "responses": { "202": { "$ref": "#/components/responses/CallbackAccepted" } } } } } }, "securitySchemes": { "key": { "type": "apiKey", "in": "header", "name": "x-smarttoken" }, "oauth": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://www.smartrecruiters.com/identity/oauth/allow", "tokenUrl": "https://api.smartrecruiters.com/identity/oauth/token", "scopes": { "webhooks_read": "View webhook subscriptions", "webhooks_write": "Create a new webhook subscription", "webhooks_delete": "Delete webhook subscription", "webhooks_manage": "View, create and delete webhook subscriptions" } } } } } }, "servers": [ { "url": "https://api.smartrecruiters.com/webhooks-api/v201907" } ] } ````