{ "openapi": "3.1.0", "info": { "title": "Webhook Management", "version": "2023-07-01", "description": "Subscribe to specific webhook events related to assignments, candidates, suppliers, expense, timesheets, and event history to receive real time updates." }, "servers": [ { "url": "https://client.beeline.com/api" }, { "url": "https://client-eu.beeline.com/api" } ], "tags": [ { "name": "External Webhooks", "description": "Use webhooks to automatically send data in response to a specific Beeline event, without any request from your system. Choose which Beeline events you’re interested in and then receive proactive notifications from your Beeline platform to your system telling you something changed when the change occurs. Next, call a Beeline API to get the additional data you need.\n\nYou can create and register multiple webhooks for your organization so that each event is sent to each webhook. You can register one postback URL to a single event you’re interested in monitoring. Or register one URL to multiple events. You can also register multiple URLs to a single event.\n\nAlthough Beeline has taken steps to minimize duplication of event messages being sent, duplicate event messages may still occur for various reasons. It is recommended to implement idempotent operations in your system to avoid consuming the same event message more than once. Additionally, event messages are created upon trigger, but may arrive to your system out of sequence due to retries or processing time. It is recommended to utilize the timestamp included in the event message to sort the event messages received.\n\nBeeline webhooks include data and executable commands sent to your app over HTTP in JSON format.\n" }, { "name": "assignment-event-types", "x-displayName": "Assignment Event Types" }, { "name": "bid-event-types", "x-displayName": "Bid Event Types" }, { "name": "candidate-event-types", "x-displayName": "Candidate Event Types" }, { "name": "invoice-event-types", "x-displayName": "Invoice Event Types" }, { "name": "project-event-types", "x-displayName": "Project Event Types" }, { "name": "request-event-types", "x-displayName": "Request Event Types" }, { "name": "sow-event-types", "x-displayName": "Statement of Work Event Types" }, { "name": "supplier-event-types", "x-displayName": "Supplier Event Types" }, { "name": "webhook-event-types", "x-displayName": "Webhook Event Types" }, { "name": "worker-event-types", "x-displayName": "Worker Event Types" }, { "name": "time-and-expense-event-types", "x-displayName": "Time & Expense Event Types" } ], "paths": { "/sites/{clientSiteId}/webhooks": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "get": { "operationId": "list-webhooks", "summary": "List Webhooks", "description": "Get a list of defined webhooks\n", "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "tags": [ "External Webhooks" ], "security": [ { "client_auth": [ "read:webhook_management" ] } ], "responses": { "200": { "description": "The list of webhooks", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of webhooks", "properties": { "maxItems": { "type": "integer", "description": "The total number of webhooks" }, "value": { "type": "array", "description": "The set of webhooks. If there are no webhooks, this will be an empty array.", "items": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "hmac" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "hmac" ] }, "hmacSecret": { "type": "string", "description": "The secret to be used for the HMAC authentication, represented as a base64 encoded string", "maxLength": 255 } } } ] }, { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "oauth2" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "oauth2" ] }, "oauth2Domain": { "type": "string", "description": "The Domain used for Oauth2 authentication", "format": "url" }, "oauth2ClientId": { "type": "string", "description": "The Client ID used for Oauth2 authentication", "maxLength": 255 }, "oauth2ClientSecret": { "type": "string", "description": "The Client Secret used for Oauth2 authentication", "maxLength": 255 }, "oauth2Audience": { "type": "string", "description": "The Audience used for Oauth2 authentication", "maxLength": 255 }, "oauth2Scope": { "type": "string", "description": "The Scope used for Oauth2 authentication", "maxLength": 255 } } } ] } ] } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "post": { "operationId": "post-webhook", "summary": "Create Webhook", "description": "Create a new Webhook.\n", "tags": [ "External Webhooks" ], "security": [ { "client_auth": [ "write:webhook_management" ] } ], "requestBody": { "description": "The details for the new webhook", "content": { "application/json": { "schema": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "baseUri", "eventTypes" ], "properties": { "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } } } }, { "title": "hmac" }, { "type": "object", "required": [ "authType", "hmacSecret" ], "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "hmac" ] }, "hmacSecret": { "type": "string", "description": "The secret to be used for the HMAC authentication, represented as a base64 encoded string", "maxLength": 255 } } } ] }, { "allOf": [ { "type": "object", "required": [ "baseUri", "eventTypes" ], "properties": { "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } } } }, { "title": "oauth2" }, { "type": "object", "required": [ "authType", "oauth2Domain", "oauth2ClientId", "oauth2ClientSecret", "oauth2Audience" ], "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "oauth2" ] }, "oauth2Domain": { "type": "string", "description": "The Domain used for Oauth2 authentication", "format": "url" }, "oauth2ClientId": { "type": "string", "description": "The Client ID used for Oauth2 authentication", "maxLength": 255 }, "oauth2ClientSecret": { "type": "string", "description": "The Client Secret used for Oauth2 authentication", "maxLength": 255 }, "oauth2Audience": { "type": "string", "description": "The Audience used for Oauth2 authentication", "maxLength": 255 }, "oauth2Scope": { "type": "string", "description": "The Scope used for Oauth2 authentication", "maxLength": 255 } } } ] } ] } } } }, "responses": { "201": { "description": "Webhook was successfully created", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } }, "Location": { "schema": { "type": "string", "format": "url" }, "example": "https://client.beeline.com/api/sites/da478252-1d8d-4ecf-9651-6b5ba39bba5b/webhooks/c8ff8c7f-c6a3-4862-87e2-3889364995ed?api-version=2023-02-28" } }, "content": { "application/json": { "schema": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "hmac" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "hmac" ] }, "hmacSecret": { "type": "string", "description": "The secret to be used for the HMAC authentication, represented as a base64 encoded string", "maxLength": 255 } } } ] }, { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "oauth2" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "oauth2" ] }, "oauth2Domain": { "type": "string", "description": "The Domain used for Oauth2 authentication", "format": "url" }, "oauth2ClientId": { "type": "string", "description": "The Client ID used for Oauth2 authentication", "maxLength": 255 }, "oauth2ClientSecret": { "type": "string", "description": "The Client Secret used for Oauth2 authentication", "maxLength": 255 }, "oauth2Audience": { "type": "string", "description": "The Audience used for Oauth2 authentication", "maxLength": 255 }, "oauth2Scope": { "type": "string", "description": "The Scope used for Oauth2 authentication", "maxLength": 255 } } } ] } ] } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/webhooks/{webhookId}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "webhookId", "description": "Uniquely identifies a webhook instance", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "get": { "operationId": "get-webhook-by-id", "summary": "Get Webhook", "description": "Get webhook information\n", "tags": [ "External Webhooks" ], "security": [ { "client_auth": [ "read:webhook_management" ] } ], "responses": { "200": { "description": "The webhook information", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "hmac" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "hmac" ] }, "hmacSecret": { "type": "string", "description": "The secret to be used for the HMAC authentication, represented as a base64 encoded string", "maxLength": 255 } } } ] }, { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "oauth2" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "oauth2" ] }, "oauth2Domain": { "type": "string", "description": "The Domain used for Oauth2 authentication", "format": "url" }, "oauth2ClientId": { "type": "string", "description": "The Client ID used for Oauth2 authentication", "maxLength": 255 }, "oauth2ClientSecret": { "type": "string", "description": "The Client Secret used for Oauth2 authentication", "maxLength": 255 }, "oauth2Audience": { "type": "string", "description": "The Audience used for Oauth2 authentication", "maxLength": 255 }, "oauth2Scope": { "type": "string", "description": "The Scope used for Oauth2 authentication", "maxLength": 255 } } } ] } ] } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "put": { "operationId": "put-webhook", "summary": "Update Webhook", "description": "Update an existing webhook\n", "tags": [ "External Webhooks" ], "security": [ { "client_auth": [ "write:webhook_management" ] } ], "requestBody": { "description": "The webhook details to be updated", "content": { "application/json": { "schema": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "baseUri", "eventTypes" ], "properties": { "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } } } }, { "title": "hmac" }, { "type": "object", "required": [ "authType", "hmacSecret" ], "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "hmac" ] }, "hmacSecret": { "type": "string", "description": "The secret to be used for the HMAC authentication, represented as a base64 encoded string", "maxLength": 255 } } } ] }, { "allOf": [ { "type": "object", "required": [ "baseUri", "eventTypes" ], "properties": { "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } } } }, { "title": "oauth2" }, { "type": "object", "required": [ "authType", "oauth2Domain", "oauth2ClientId", "oauth2ClientSecret", "oauth2Audience" ], "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "oauth2" ] }, "oauth2Domain": { "type": "string", "description": "The Domain used for Oauth2 authentication", "format": "url" }, "oauth2ClientId": { "type": "string", "description": "The Client ID used for Oauth2 authentication", "maxLength": 255 }, "oauth2ClientSecret": { "type": "string", "description": "The Client Secret used for Oauth2 authentication", "maxLength": 255 }, "oauth2Audience": { "type": "string", "description": "The Audience used for Oauth2 authentication", "maxLength": 255 }, "oauth2Scope": { "type": "string", "description": "The Scope used for Oauth2 authentication", "maxLength": 255 } } } ] } ] } } } }, "responses": { "200": { "description": "Webhook was successfully updated", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "hmac" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "hmac" ] }, "hmacSecret": { "type": "string", "description": "The secret to be used for the HMAC authentication, represented as a base64 encoded string", "maxLength": 255 } } } ] }, { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "oauth2" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "oauth2" ] }, "oauth2Domain": { "type": "string", "description": "The Domain used for Oauth2 authentication", "format": "url" }, "oauth2ClientId": { "type": "string", "description": "The Client ID used for Oauth2 authentication", "maxLength": 255 }, "oauth2ClientSecret": { "type": "string", "description": "The Client Secret used for Oauth2 authentication", "maxLength": 255 }, "oauth2Audience": { "type": "string", "description": "The Audience used for Oauth2 authentication", "maxLength": 255 }, "oauth2Scope": { "type": "string", "description": "The Scope used for Oauth2 authentication", "maxLength": 255 } } } ] } ] } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "delete": { "operationId": "delete-webhook", "summary": "Delete Webhook", "description": "Delete an existing webhook\n", "tags": [ "External Webhooks" ], "security": [ { "client_auth": [ "write:webhook_management" ] } ], "responses": { "200": { "description": "Webhook was successfully removed", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/webhooks/{webhookId}/validate/{validationCode}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "webhookId", "description": "Uniquely identifies a webhook instance", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "validationCode", "description": "The webhook validation code", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "post": { "operationId": "validate-webhook", "summary": "Validate webhook", "description": "Validate a webhook. When you create, modify or activate a webhook, we will send a `webhook.validation` event, with a validation code. The webhook will be `pending`, waiting for validation until you call this endpoint to validate you received the webhook validation event. Once validated, you will start receiving the events you have specified in the `eventTypes` property on the webhook. If we do not receive the validation code response in 10 minutes, we will mark the webhook as inactive.\n", "tags": [ "External Webhooks" ], "security": [ { "client_auth": [ "write:webhook_management" ] } ], "responses": { "200": { "description": "The webhook has been successfully validated", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "hmac" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "hmac" ] }, "hmacSecret": { "type": "string", "description": "The secret to be used for the HMAC authentication, represented as a base64 encoded string", "maxLength": 255 } } } ] }, { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "oauth2" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "oauth2" ] }, "oauth2Domain": { "type": "string", "description": "The Domain used for Oauth2 authentication", "format": "url" }, "oauth2ClientId": { "type": "string", "description": "The Client ID used for Oauth2 authentication", "maxLength": 255 }, "oauth2ClientSecret": { "type": "string", "description": "The Client Secret used for Oauth2 authentication", "maxLength": 255 }, "oauth2Audience": { "type": "string", "description": "The Audience used for Oauth2 authentication", "maxLength": 255 }, "oauth2Scope": { "type": "string", "description": "The Scope used for Oauth2 authentication", "maxLength": 255 } } } ] } ] } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/webhooks/{webhookId}/ping": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "webhookId", "description": "Uniquely identifies a webhook instance", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "post": { "operationId": "ping-webhook", "summary": "Send Ping event", "description": "Send a `webhook.ping` event to the webhook\n", "tags": [ "External Webhooks" ], "security": [ { "client_auth": [ "write:webhook_management" ] } ], "responses": { "200": { "description": "The ping event has been queued", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "hmac" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "hmac" ] }, "hmacSecret": { "type": "string", "description": "The secret to be used for the HMAC authentication, represented as a base64 encoded string", "maxLength": 255 } } } ] }, { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "oauth2" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "oauth2" ] }, "oauth2Domain": { "type": "string", "description": "The Domain used for Oauth2 authentication", "format": "url" }, "oauth2ClientId": { "type": "string", "description": "The Client ID used for Oauth2 authentication", "maxLength": 255 }, "oauth2ClientSecret": { "type": "string", "description": "The Client Secret used for Oauth2 authentication", "maxLength": 255 }, "oauth2Audience": { "type": "string", "description": "The Audience used for Oauth2 authentication", "maxLength": 255 }, "oauth2Scope": { "type": "string", "description": "The Scope used for Oauth2 authentication", "maxLength": 255 } } } ] } ] } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/webhooks/{webhookId}/deactivate": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "webhookId", "description": "Uniquely identifies a webhook instance", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "post": { "operationId": "deactivate-webhook", "summary": "Deactivate Webhook", "description": "Deactivate an active webhook. You will stop receiving webhook events unless you re-activate the webhook.\n", "tags": [ "External Webhooks" ], "security": [ { "client_auth": [ "write:webhook_management" ] } ], "responses": { "200": { "description": "The webhook is marked `inactive`", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "hmac" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "hmac" ] }, "hmacSecret": { "type": "string", "description": "The secret to be used for the HMAC authentication, represented as a base64 encoded string", "maxLength": 255 } } } ] }, { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "oauth2" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "oauth2" ] }, "oauth2Domain": { "type": "string", "description": "The Domain used for Oauth2 authentication", "format": "url" }, "oauth2ClientId": { "type": "string", "description": "The Client ID used for Oauth2 authentication", "maxLength": 255 }, "oauth2ClientSecret": { "type": "string", "description": "The Client Secret used for Oauth2 authentication", "maxLength": 255 }, "oauth2Audience": { "type": "string", "description": "The Audience used for Oauth2 authentication", "maxLength": 255 }, "oauth2Scope": { "type": "string", "description": "The Scope used for Oauth2 authentication", "maxLength": 255 } } } ] } ] } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/webhooks/{webhookId}/activate": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "webhookId", "description": "Uniquely identifies a webhook instance", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "post": { "operationId": "activate-webhook", "summary": "Activate Webhook", "description": "Activate an inactive webhook. You will receive a `webhook.validation` event, and the webhook will be pending until you call the validate endpoint.\n", "tags": [ "External Webhooks" ], "security": [ { "client_auth": [ "write:webhook_management" ] } ], "responses": { "200": { "description": "The webhook is marked `pending`, waiting on validation before activation.", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "hmac" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "hmac" ] }, "hmacSecret": { "type": "string", "description": "The secret to be used for the HMAC authentication, represented as a base64 encoded string", "maxLength": 255 } } } ] }, { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "oauth2" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "oauth2" ] }, "oauth2Domain": { "type": "string", "description": "The Domain used for Oauth2 authentication", "format": "url" }, "oauth2ClientId": { "type": "string", "description": "The Client ID used for Oauth2 authentication", "maxLength": 255 }, "oauth2ClientSecret": { "type": "string", "description": "The Client Secret used for Oauth2 authentication", "maxLength": 255 }, "oauth2Audience": { "type": "string", "description": "The Audience used for Oauth2 authentication", "maxLength": 255 }, "oauth2Scope": { "type": "string", "description": "The Scope used for Oauth2 authentication", "maxLength": 255 } } } ] } ] } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/webhooks/{webhookId}/events": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "webhookId", "description": "Uniquely identifies a webhook instance", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "get": { "operationId": "list-event-history", "summary": "Get Event History", "description": "Get the list of events sent to this endpoint\n", "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "tags": [ "External Webhooks" ], "security": [ { "client_auth": [ "read:webhook_management" ] } ], "responses": { "200": { "description": "The list of event webhook instances", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of event webhook instances", "properties": { "maxItems": { "type": "integer", "description": "The total number of event webhook instances" }, "value": { "type": "array", "description": "The set of event webhook instances. If there are no items, this will be an empty array.", "items": { "type": "object", "properties": { "eventPayload": { "description": "The information about the event payload", "oneOf": [ { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amended" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amended" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "amendmentDate": { "type": "string", "format": "date-time" }, "amendmentTypeDetails": { "type": "array", "description": "List of field names changed on the assignment.", "items": { "type": "string" } } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendment.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendment.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendment.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendment.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendmentprocess.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendmentprocess.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "amendmentId", "processId", "processStatus", "message", "updateDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "amendmentId": { "type": "string", "format": "uuid" }, "processId": { "type": "string", "format": "uuid" }, "processStatus": { "type": "string", "enum": [ "Received", "Running", "Success", "Error" ] }, "message": { "type": "string" }, "updateDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.detailchanged" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.detailchanged" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "changedDate": { "type": "string", "format": "date-time" }, "amendmentTypeDetails": { "type": "array", "description": "List of field names changed on the assignment.", "items": { "type": "string" } }, "changedClientDefinedFields": { "type": "array", "description": "List of client defined field names changed on the assignment.", "items": { "type": "string" } } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.didnotshow" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.didnotshow" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "noShowDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.expired" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.expired" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "expiredDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extended" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extended" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "extendedDate": { "type": [ "string", "null" ], "format": "date-time" }, "endDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extension.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extension.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extension.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extension.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.group.extension.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.group.extension.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentIds", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.imported" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.imported" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "candidateId": { "type": [ "string", "null" ], "format": "uuid" }, "dateImported": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "candidateId": { "type": [ "string", "null" ], "format": "uuid" }, "startDate": { "type": "string", "format": "date" }, "dateScheduled": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.started" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.started" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "startedDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.terminated" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.terminated" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "terminationDate": { "type": [ "string", "null" ], "format": "date-time" }, "terminationReason": { "type": [ "string", "null" ] } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.termination.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.termination.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.termination.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.termination.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "bid.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bid.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "bidId", "statusId", "dateSubmitted" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "bidId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateSubmitted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateCancelled": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.hm.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.hm.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateCancelled": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateCompleted": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.pending.msp.approval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.pending.msp.approval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.qualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.qualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateQualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.requested" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.requested" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRequested": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.required" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.required" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRequired": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateScheduled": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.msp.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.msp.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.msp.qualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.msp.qualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateQualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.accepted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.accepted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateAccepted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.started" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.started" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateStarted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.withdrawn" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.withdrawn" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateWithdrawn": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.onboarded" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.onboarded" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateOnboarded": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.background.checks" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.background.checks" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.confirmation" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.confirmation" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.onboarding" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.onboarding" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.onboarding.processing" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.onboarding.processing" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.submission" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.submission" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.ready.for.offer" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.ready.for.offer" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateReadyForOffer": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.resume.added" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.resume.added" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "attachmentId", "dateAdded" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "attachmentId": { "type": "string", "format": "uuid" }, "dateAdded": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.resume.removed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.resume.removed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "attachmentId", "dateRemoved" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "attachmentId": { "type": "string", "format": "uuid" }, "dateRemoved": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.selected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.selected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateSelected": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateSubmitted": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.withdrawn" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.withdrawn" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateWithdrawn": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "invoice.finalinvoice.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "invoice.finalinvoice.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "invoiceId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "integer", "example": 1000 }, "categoryName": { "type": "string", "example": "US Staff Aug Final Time" }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" }, "invoiceProcessDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "invoice.retrieved" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "invoice.retrieved" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "invoiceId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "integer", "example": 1000 }, "paymentType": { "type": "string", "enum": [ "staffAugTimesheet", "staffAugExpense", "staffAugMiscFee", "projectServiceTimesheet", "projectServiceMiscFee", "projectServiceMilestone", "projectServiceExpense" ] }, "skip": { "type": "integer", "example": 10 }, "pageSize": { "type": "integer", "example": 20 }, "maxItems": { "type": "integer", "example": 500 }, "dateRetrieved": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "dateRejected" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "dateScheduled" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "dateScheduled": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": [ "string" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.edited" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.edited" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId", "editedDate", "editedFields", "editedClientDefinedFields" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "editedDate": { "type": [ "string" ], "format": "date-time" }, "editedFields": { "type": "array", "description": "List of field names edited on the request.", "items": { "type": "string", "enum": [ "EndDate", "EstimatedCost", "EstimatedExpense", "HoursPerWeek", "Quantity", "ReasonForRequest", "StartDate" ] } }, "editedClientDefinedFields": { "type": "array", "description": "List of client defined field names edited on the request.", "items": { "type": "string" } } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.filled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.filled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "totalPositionsFilled": { "type": "integer" }, "filledDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.group.edited" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.group.edited" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestIds", "editedDate", "editedFields" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "editedDate": { "type": [ "string" ], "format": "date-time" }, "editedFields": { "type": "array", "description": "List of field names edited on the request group.", "items": { "type": "string", "enum": [ "AdminCostCenter", "BillToCostCenter", "HiringManager", "PhysicalWorkLocation", "TaxLocation" ] } } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.opened" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.opened" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "dateOpened": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.placedonhold" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.placedonhold" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "datePlacedOnHold": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.releasedtosupplier" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.releasedtosupplier" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId", "supplierId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "supplierId": { "type": "string", "format": "uuid" }, "releasedToSupplierDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.reopened" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.reopened" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "dateReOpened": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "requestSubmitted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.attachment.added" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.attachment.added" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "persona", "attachmentId", "sowSection", "dateAdded" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "persona": { "type": "string", "description": "Identifies whether the detail the attachment was added to was created by the client or vendor. Attachment changes made to details created by the vendor will not be readily available to client access until the statement of work has been submitted back to the client for approval.\n", "enum": [ "client", "vendor" ] }, "attachmentId": { "type": "string", "format": "uuid" }, "sowSection": { "type": "string", "description": "Section of the SOW where the attachment was added.", "enum": [ "sowGeneral", "sowTerms" ] }, "dateAdded": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.attachment.removed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.attachment.removed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "persona", "attachmentId", "sowSection", "dateRemoved" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "persona": { "type": "string", "description": "Identifies whether the detail the attachment was removed from was created by the client or vendor. Attachment changes made to details created by the vendor will not be readily available to client access until the statement of work has been submitted back to the client for approval.\n", "enum": [ "client", "vendor" ] }, "attachmentId": { "type": "string", "format": "uuid" }, "sowSection": { "type": "string", "description": "Section of the SOW where the attachment was removed.", "enum": [ "sowGeneral", "sowTerms" ] }, "dateRemoved": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendingclientapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendingclientapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendingfinalapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendingfinalapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendinginitialapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendinginitialapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.readytonegotiate" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.readytonegotiate" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "dateReady" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateReady": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.sourcingcomplete" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.sourcingcomplete" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "dateCompleted" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateCompleted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "timesheet.submittedforapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "timesheet.submittedforapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "timesheetId", "submitDate", "sourceType" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "timesheetId": { "type": "string", "format": "uuid" }, "submitDate": { "type": "string", "format": "date-time" }, "sourceType": { "type": "string", "enum": [ "Api", "Application", "Import", "Mobile", "WebImport" ] } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "webhook.ping" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "webhook.ping" ] }, "data": { "type": "object", "required": [ "webhookId" ], "properties": { "webhookId": { "type": "string", "format": "uuid" }, "pingTime": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "webhook.validation" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "webhook.validation" ] }, "data": { "type": "object", "properties": { "validationCode": { "type": "string" }, "validationUrl": { "type": "string", "format": "uri" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.beelineuniqueid.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.beelineuniqueid.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.email.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.email.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.externalid.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.externalid.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.name.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.name.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.phonenumber.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.phonenumber.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.username.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.username.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } ] }, "attempts": { "description": "The data for all attempts to send the event to the webhook endpoint", "type": "array", "items": { "type": "object", "properties": { "attemptTime": { "type": "string", "description": "The timestamp for the attempt", "format": "date-time" }, "responseCode": { "type": "string", "description": "The response code from the webhook endpoint" }, "message": { "type": "string", "description": "The status message of the attempt" } } } } } } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/webhooks/{webhookId}/events/{eventId}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "webhookId", "description": "Uniquely identifies a webhook instance", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "eventId", "description": "Uniquely identifies an event webhook instance", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "get": { "operationId": "get-event", "summary": "Get Event Details", "description": "Get event detail information, including information about attempts to send the event\n", "tags": [ "External Webhooks" ], "security": [ { "client_auth": [ "read:webhook_management" ] } ], "responses": { "200": { "description": "The event detail information", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "eventPayload": { "description": "The information about the event payload", "oneOf": [ { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amended" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amended" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "amendmentDate": { "type": "string", "format": "date-time" }, "amendmentTypeDetails": { "type": "array", "description": "List of field names changed on the assignment.", "items": { "type": "string" } } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendment.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendment.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendment.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendment.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendmentprocess.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendmentprocess.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "amendmentId", "processId", "processStatus", "message", "updateDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "amendmentId": { "type": "string", "format": "uuid" }, "processId": { "type": "string", "format": "uuid" }, "processStatus": { "type": "string", "enum": [ "Received", "Running", "Success", "Error" ] }, "message": { "type": "string" }, "updateDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.detailchanged" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.detailchanged" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "changedDate": { "type": "string", "format": "date-time" }, "amendmentTypeDetails": { "type": "array", "description": "List of field names changed on the assignment.", "items": { "type": "string" } }, "changedClientDefinedFields": { "type": "array", "description": "List of client defined field names changed on the assignment.", "items": { "type": "string" } } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.didnotshow" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.didnotshow" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "noShowDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.expired" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.expired" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "expiredDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extended" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extended" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "extendedDate": { "type": [ "string", "null" ], "format": "date-time" }, "endDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extension.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extension.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extension.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extension.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.group.extension.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.group.extension.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentIds", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.imported" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.imported" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "candidateId": { "type": [ "string", "null" ], "format": "uuid" }, "dateImported": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "candidateId": { "type": [ "string", "null" ], "format": "uuid" }, "startDate": { "type": "string", "format": "date" }, "dateScheduled": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.started" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.started" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "startedDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.terminated" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.terminated" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "terminationDate": { "type": [ "string", "null" ], "format": "date-time" }, "terminationReason": { "type": [ "string", "null" ] } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.termination.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.termination.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.termination.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.termination.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "bid.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bid.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "bidId", "statusId", "dateSubmitted" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "bidId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateSubmitted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateCancelled": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.hm.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.hm.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateCancelled": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateCompleted": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.pending.msp.approval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.pending.msp.approval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.qualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.qualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateQualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.requested" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.requested" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRequested": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.required" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.required" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRequired": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateScheduled": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.msp.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.msp.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.msp.qualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.msp.qualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateQualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.accepted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.accepted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateAccepted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.started" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.started" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateStarted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.withdrawn" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.withdrawn" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateWithdrawn": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.onboarded" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.onboarded" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateOnboarded": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.background.checks" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.background.checks" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.confirmation" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.confirmation" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.onboarding" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.onboarding" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.onboarding.processing" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.onboarding.processing" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.submission" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.submission" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.ready.for.offer" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.ready.for.offer" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateReadyForOffer": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.resume.added" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.resume.added" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "attachmentId", "dateAdded" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "attachmentId": { "type": "string", "format": "uuid" }, "dateAdded": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.resume.removed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.resume.removed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "attachmentId", "dateRemoved" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "attachmentId": { "type": "string", "format": "uuid" }, "dateRemoved": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.selected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.selected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateSelected": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateSubmitted": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.withdrawn" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.withdrawn" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateWithdrawn": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "invoice.finalinvoice.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "invoice.finalinvoice.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "invoiceId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "integer", "example": 1000 }, "categoryName": { "type": "string", "example": "US Staff Aug Final Time" }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" }, "invoiceProcessDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "invoice.retrieved" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "invoice.retrieved" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "invoiceId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "integer", "example": 1000 }, "paymentType": { "type": "string", "enum": [ "staffAugTimesheet", "staffAugExpense", "staffAugMiscFee", "projectServiceTimesheet", "projectServiceMiscFee", "projectServiceMilestone", "projectServiceExpense" ] }, "skip": { "type": "integer", "example": 10 }, "pageSize": { "type": "integer", "example": 20 }, "maxItems": { "type": "integer", "example": 500 }, "dateRetrieved": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "dateRejected" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "dateScheduled" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "dateScheduled": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": [ "string" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.edited" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.edited" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId", "editedDate", "editedFields", "editedClientDefinedFields" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "editedDate": { "type": [ "string" ], "format": "date-time" }, "editedFields": { "type": "array", "description": "List of field names edited on the request.", "items": { "type": "string", "enum": [ "EndDate", "EstimatedCost", "EstimatedExpense", "HoursPerWeek", "Quantity", "ReasonForRequest", "StartDate" ] } }, "editedClientDefinedFields": { "type": "array", "description": "List of client defined field names edited on the request.", "items": { "type": "string" } } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.filled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.filled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "totalPositionsFilled": { "type": "integer" }, "filledDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.group.edited" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.group.edited" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestIds", "editedDate", "editedFields" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "editedDate": { "type": [ "string" ], "format": "date-time" }, "editedFields": { "type": "array", "description": "List of field names edited on the request group.", "items": { "type": "string", "enum": [ "AdminCostCenter", "BillToCostCenter", "HiringManager", "PhysicalWorkLocation", "TaxLocation" ] } } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.opened" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.opened" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "dateOpened": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.placedonhold" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.placedonhold" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "datePlacedOnHold": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.releasedtosupplier" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.releasedtosupplier" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId", "supplierId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "supplierId": { "type": "string", "format": "uuid" }, "releasedToSupplierDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.reopened" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.reopened" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "dateReOpened": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "requestSubmitted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.attachment.added" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.attachment.added" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "persona", "attachmentId", "sowSection", "dateAdded" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "persona": { "type": "string", "description": "Identifies whether the detail the attachment was added to was created by the client or vendor. Attachment changes made to details created by the vendor will not be readily available to client access until the statement of work has been submitted back to the client for approval.\n", "enum": [ "client", "vendor" ] }, "attachmentId": { "type": "string", "format": "uuid" }, "sowSection": { "type": "string", "description": "Section of the SOW where the attachment was added.", "enum": [ "sowGeneral", "sowTerms" ] }, "dateAdded": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.attachment.removed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.attachment.removed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "persona", "attachmentId", "sowSection", "dateRemoved" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "persona": { "type": "string", "description": "Identifies whether the detail the attachment was removed from was created by the client or vendor. Attachment changes made to details created by the vendor will not be readily available to client access until the statement of work has been submitted back to the client for approval.\n", "enum": [ "client", "vendor" ] }, "attachmentId": { "type": "string", "format": "uuid" }, "sowSection": { "type": "string", "description": "Section of the SOW where the attachment was removed.", "enum": [ "sowGeneral", "sowTerms" ] }, "dateRemoved": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendingclientapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendingclientapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendingfinalapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendingfinalapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendinginitialapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendinginitialapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.readytonegotiate" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.readytonegotiate" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "dateReady" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateReady": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.sourcingcomplete" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.sourcingcomplete" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "dateCompleted" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateCompleted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "timesheet.submittedforapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "timesheet.submittedforapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "timesheetId", "submitDate", "sourceType" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "timesheetId": { "type": "string", "format": "uuid" }, "submitDate": { "type": "string", "format": "date-time" }, "sourceType": { "type": "string", "enum": [ "Api", "Application", "Import", "Mobile", "WebImport" ] } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "webhook.ping" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "webhook.ping" ] }, "data": { "type": "object", "required": [ "webhookId" ], "properties": { "webhookId": { "type": "string", "format": "uuid" }, "pingTime": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "webhook.validation" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "webhook.validation" ] }, "data": { "type": "object", "properties": { "validationCode": { "type": "string" }, "validationUrl": { "type": "string", "format": "uri" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.beelineuniqueid.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.beelineuniqueid.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.email.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.email.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.externalid.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.externalid.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.name.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.name.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.phonenumber.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.phonenumber.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.username.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.username.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } ] }, "attempts": { "description": "The data for all attempts to send the event to the webhook endpoint", "type": "array", "items": { "type": "object", "properties": { "attemptTime": { "type": "string", "description": "The timestamp for the attempt", "format": "date-time" }, "responseCode": { "type": "string", "description": "The response code from the webhook endpoint" }, "message": { "type": "string", "description": "The status message of the attempt" } } } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } } }, "webhooks": { "assignment.amended": { "post": { "operationId": "assignment.amended", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amended" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amended" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "amendmentDate": { "type": "string", "format": "date-time" }, "amendmentTypeDetails": { "type": "array", "description": "List of field names changed on the assignment.", "items": { "type": "string" } } } } } } ] } } } } } }, "assignment.amendment.cancelled": { "post": { "operationId": "assignment.amendment.cancelled", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendment.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendment.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "assignment.amendment.rejected": { "post": { "operationId": "assignment.amendment.rejected", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendment.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendment.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "assignment.amendmentprocess.completed": { "post": { "operationId": "assignment.amendmentprocess.completed", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendmentprocess.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendmentprocess.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "amendmentId", "processId", "processStatus", "message", "updateDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "amendmentId": { "type": "string", "format": "uuid" }, "processId": { "type": "string", "format": "uuid" }, "processStatus": { "type": "string", "enum": [ "Received", "Running", "Success", "Error" ] }, "message": { "type": "string" }, "updateDate": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "assignment.cancelled": { "post": { "operationId": "assignment.cancelled", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] } } } } } }, "assignment.detailchanged": { "post": { "operationId": "assignment.detailchanged", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.detailchanged" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.detailchanged" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "changedDate": { "type": "string", "format": "date-time" }, "amendmentTypeDetails": { "type": "array", "description": "List of field names changed on the assignment.", "items": { "type": "string" } }, "changedClientDefinedFields": { "type": "array", "description": "List of client defined field names changed on the assignment.", "items": { "type": "string" } } } } } } ] } } } } } }, "assignment.didnotshow": { "post": { "operationId": "assignment.didnotshow", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.didnotshow" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.didnotshow" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "noShowDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] } } } } } }, "assignment.expired": { "post": { "operationId": "assignment.expired", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.expired" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.expired" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "expiredDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] } } } } } }, "assignment.extended": { "post": { "operationId": "assignment.extended", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extended" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extended" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "extendedDate": { "type": [ "string", "null" ], "format": "date-time" }, "endDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] } } } } } }, "assignment.extension.cancelled": { "post": { "operationId": "assignment.extension.cancelled", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extension.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extension.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "assignment.extension.rejected": { "post": { "operationId": "assignment.extension.rejected", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extension.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extension.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "assignment.group.extension.rejected": { "post": { "operationId": "assignment.group.extension.rejected", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.group.extension.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.group.extension.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentIds", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "assignment.imported": { "post": { "operationId": "assignment.imported", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.imported" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.imported" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "candidateId": { "type": [ "string", "null" ], "format": "uuid" }, "dateImported": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] } } } } } }, "assignment.scheduled": { "post": { "operationId": "assignment.scheduled", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "candidateId": { "type": [ "string", "null" ], "format": "uuid" }, "startDate": { "type": "string", "format": "date" }, "dateScheduled": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "assignment.started": { "post": { "operationId": "assignment.started", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.started" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.started" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "startedDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] } } } } } }, "assignment.terminated": { "post": { "operationId": "assignment.terminated", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.terminated" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.terminated" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "terminationDate": { "type": [ "string", "null" ], "format": "date-time" }, "terminationReason": { "type": [ "string", "null" ] } } } } } ] } } } } } }, "assignment.termination.cancelled": { "post": { "operationId": "assignment.termination.cancelled", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.termination.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.termination.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "assignment.termination.rejected": { "post": { "operationId": "assignment.termination.rejected", "tags": [ "assignment-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.termination.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.termination.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "bid.submitted": { "post": { "operationId": "bid.submitted", "tags": [ "bid-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "bid.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bid.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "bidId", "statusId", "dateSubmitted" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "bidId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateSubmitted": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.cancelled": { "post": { "operationId": "candidate.cancelled", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateCancelled": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.disqualified": { "post": { "operationId": "candidate.disqualified", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.hm.disqualified": { "post": { "operationId": "candidate.hm.disqualified", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.hm.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.hm.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.interview.cancelled": { "post": { "operationId": "candidate.interview.cancelled", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateCancelled": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] } } } } } }, "candidate.interview.completed": { "post": { "operationId": "candidate.interview.completed", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateCompleted": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] } } } } } }, "candidate.interview.pending": { "post": { "operationId": "candidate.interview.pending", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.interview.pending.msp.approval": { "post": { "operationId": "candidate.interview.pending.msp.approval", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.pending.msp.approval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.pending.msp.approval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.interview.qualified": { "post": { "operationId": "candidate.interview.qualified", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.qualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.qualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateQualified": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.interview.rejected": { "post": { "operationId": "candidate.interview.rejected", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.interview.requested": { "post": { "operationId": "candidate.interview.requested", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.requested" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.requested" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRequested": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] } } } } } }, "candidate.interview.required": { "post": { "operationId": "candidate.interview.required", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.required" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.required" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRequired": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.interview.scheduled": { "post": { "operationId": "candidate.interview.scheduled", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateScheduled": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] } } } } } }, "candidate.msp.disqualified": { "post": { "operationId": "candidate.msp.disqualified", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.msp.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.msp.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.msp.qualified": { "post": { "operationId": "candidate.msp.qualified", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.msp.qualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.msp.qualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateQualified": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.offer.accepted": { "post": { "operationId": "candidate.offer.accepted", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.accepted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.accepted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateAccepted": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.offer.pending": { "post": { "operationId": "candidate.offer.pending", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.offer.rejected": { "post": { "operationId": "candidate.offer.rejected", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.offer.started": { "post": { "operationId": "candidate.offer.started", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.started" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.started" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateStarted": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.offer.withdrawn": { "post": { "operationId": "candidate.offer.withdrawn", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.withdrawn" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.withdrawn" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateWithdrawn": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.onboarded": { "post": { "operationId": "candidate.onboarded", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.onboarded" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.onboarded" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateOnboarded": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.pending.background.checks": { "post": { "operationId": "candidate.pending.background.checks", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.background.checks" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.background.checks" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.pending.confirmation": { "post": { "operationId": "candidate.pending.confirmation", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.confirmation" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.confirmation" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.pending.onboarding": { "post": { "operationId": "candidate.pending.onboarding", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.onboarding" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.onboarding" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.pending.onboarding.processing": { "post": { "operationId": "candidate.pending.onboarding.processing", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.onboarding.processing" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.onboarding.processing" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.pending.submission": { "post": { "operationId": "candidate.pending.submission", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.submission" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.submission" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.ready.for.offer": { "post": { "operationId": "candidate.ready.for.offer", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.ready.for.offer" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.ready.for.offer" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateReadyForOffer": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.rejected": { "post": { "operationId": "candidate.rejected", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] } } } } } }, "candidate.resume.added": { "post": { "operationId": "candidate.resume.added", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.resume.added" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.resume.added" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "attachmentId", "dateAdded" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "attachmentId": { "type": "string", "format": "uuid" }, "dateAdded": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.resume.removed": { "post": { "operationId": "candidate.resume.removed", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.resume.removed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.resume.removed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "attachmentId", "dateRemoved" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "attachmentId": { "type": "string", "format": "uuid" }, "dateRemoved": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "candidate.selected": { "post": { "operationId": "candidate.selected", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.selected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.selected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateSelected": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] } } } } } }, "candidate.submitted": { "post": { "operationId": "candidate.submitted", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateSubmitted": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] } } } } } }, "candidate.withdrawn": { "post": { "operationId": "candidate.withdrawn", "tags": [ "candidate-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.withdrawn" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.withdrawn" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateWithdrawn": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] } } } } } }, "request.cancelled": { "post": { "operationId": "request.cancelled", "tags": [ "request-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": [ "string" ], "format": "date-time" } } } } } ] } } } } } }, "request.edited": { "post": { "operationId": "request.edited", "tags": [ "request-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.edited" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.edited" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId", "editedDate", "editedFields", "editedClientDefinedFields" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "editedDate": { "type": [ "string" ], "format": "date-time" }, "editedFields": { "type": "array", "description": "List of field names edited on the request.", "items": { "type": "string", "enum": [ "EndDate", "EstimatedCost", "EstimatedExpense", "HoursPerWeek", "Quantity", "ReasonForRequest", "StartDate" ] } }, "editedClientDefinedFields": { "type": "array", "description": "List of client defined field names edited on the request.", "items": { "type": "string" } } } } } } ] } } } } } }, "request.filled": { "post": { "operationId": "request.filled", "tags": [ "request-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.filled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.filled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "totalPositionsFilled": { "type": "integer" }, "filledDate": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "request.group.edited": { "post": { "operationId": "request.group.edited", "tags": [ "request-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.group.edited" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.group.edited" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestIds", "editedDate", "editedFields" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "editedDate": { "type": [ "string" ], "format": "date-time" }, "editedFields": { "type": "array", "description": "List of field names edited on the request group.", "items": { "type": "string", "enum": [ "AdminCostCenter", "BillToCostCenter", "HiringManager", "PhysicalWorkLocation", "TaxLocation" ] } } } } } } ] } } } } } }, "request.opened": { "post": { "operationId": "request.opened", "tags": [ "request-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.opened" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.opened" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "dateOpened": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "request.placedonhold": { "post": { "operationId": "request.placedonhold", "tags": [ "request-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.placedonhold" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.placedonhold" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "datePlacedOnHold": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "request.releasedtosupplier": { "post": { "operationId": "request.releasedtosupplier", "tags": [ "request-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.releasedtosupplier" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.releasedtosupplier" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId", "supplierId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "supplierId": { "type": "string", "format": "uuid" }, "releasedToSupplierDate": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "request.reopened": { "post": { "operationId": "request.reopened", "tags": [ "request-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.reopened" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.reopened" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "dateReOpened": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "request.submitted": { "post": { "operationId": "request.submitted", "tags": [ "request-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "requestSubmitted": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "timesheet.submittedforapproval": { "post": { "operationId": "timesheet.submittedforapproval", "tags": [ "time-and-expense-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "timesheet.submittedforapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "timesheet.submittedforapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "timesheetId", "submitDate", "sourceType" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "timesheetId": { "type": "string", "format": "uuid" }, "submitDate": { "type": "string", "format": "date-time" }, "sourceType": { "type": "string", "enum": [ "Api", "Application", "Import", "Mobile", "WebImport" ] } } } } } ] } } } } } }, "worker.beelineuniqueid.changed": { "post": { "operationId": "worker.beelineuniqueid.changed", "tags": [ "worker-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.beelineuniqueid.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.beelineuniqueid.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "worker.email.changed": { "post": { "operationId": "worker.email.changed", "tags": [ "worker-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.email.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.email.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "worker.externalid.changed": { "post": { "operationId": "worker.externalid.changed", "tags": [ "worker-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.externalid.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.externalid.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "worker.name.changed": { "post": { "operationId": "worker.name.changed", "tags": [ "worker-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.name.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.name.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "worker.phonenumber.changed": { "post": { "operationId": "worker.phonenumber.changed", "tags": [ "worker-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.phonenumber.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.phonenumber.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "worker.username.changed": { "post": { "operationId": "worker.username.changed", "tags": [ "worker-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.username.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.username.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "invoice.finalinvoice.completed": { "post": { "operationId": "invoice.finalinvoice.completed", "tags": [ "invoice-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "invoice.finalinvoice.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "invoice.finalinvoice.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "invoiceId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "integer", "example": 1000 }, "categoryName": { "type": "string", "example": "US Staff Aug Final Time" }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" }, "invoiceProcessDate": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "invoice.retrieved": { "post": { "operationId": "invoice.retrieved", "tags": [ "invoice-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "invoice.retrieved" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "invoice.retrieved" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "invoiceId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "integer", "example": 1000 }, "paymentType": { "type": "string", "enum": [ "staffAugTimesheet", "staffAugExpense", "staffAugMiscFee", "projectServiceTimesheet", "projectServiceMiscFee", "projectServiceMilestone", "projectServiceExpense" ] }, "skip": { "type": "integer", "example": 10 }, "pageSize": { "type": "integer", "example": 20 }, "maxItems": { "type": "integer", "example": 500 }, "dateRetrieved": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "project.milestone.payment.pending": { "post": { "operationId": "project.milestone.payment.pending", "tags": [ "project-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "project.milestone.payment.rejected": { "post": { "operationId": "project.milestone.payment.rejected", "tags": [ "project-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "dateRejected" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "project.milestone.payment.scheduled": { "post": { "operationId": "project.milestone.payment.scheduled", "tags": [ "project-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "dateScheduled" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "dateScheduled": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "sow.attachment.added": { "post": { "operationId": "sow.attachment.added", "tags": [ "sow-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.attachment.added" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.attachment.added" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "persona", "attachmentId", "sowSection", "dateAdded" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "persona": { "type": "string", "description": "Identifies whether the detail the attachment was added to was created by the client or vendor. Attachment changes made to details created by the vendor will not be readily available to client access until the statement of work has been submitted back to the client for approval.\n", "enum": [ "client", "vendor" ] }, "attachmentId": { "type": "string", "format": "uuid" }, "sowSection": { "type": "string", "description": "Section of the SOW where the attachment was added.", "enum": [ "sowGeneral", "sowTerms" ] }, "dateAdded": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "sow.attachment.removed": { "post": { "operationId": "sow.attachment.removed", "tags": [ "sow-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.attachment.removed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.attachment.removed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "persona", "attachmentId", "sowSection", "dateRemoved" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "persona": { "type": "string", "description": "Identifies whether the detail the attachment was removed from was created by the client or vendor. Attachment changes made to details created by the vendor will not be readily available to client access until the statement of work has been submitted back to the client for approval.\n", "enum": [ "client", "vendor" ] }, "attachmentId": { "type": "string", "format": "uuid" }, "sowSection": { "type": "string", "description": "Section of the SOW where the attachment was removed.", "enum": [ "sowGeneral", "sowTerms" ] }, "dateRemoved": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "sow.pendingclientapproval": { "post": { "operationId": "sow.pendingclientapproval", "tags": [ "sow-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendingclientapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendingclientapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "sow.pendingfinalapproval": { "post": { "operationId": "sow.pendingfinalapproval", "tags": [ "sow-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendingfinalapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendingfinalapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "sow.pendinginitialapproval": { "post": { "operationId": "sow.pendinginitialapproval", "tags": [ "sow-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendinginitialapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendinginitialapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "sow.readytonegotiate": { "post": { "operationId": "sow.readytonegotiate", "tags": [ "sow-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.readytonegotiate" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.readytonegotiate" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "dateReady" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateReady": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "sow.sourcingcomplete": { "post": { "operationId": "sow.sourcingcomplete", "tags": [ "sow-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.sourcingcomplete" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.sourcingcomplete" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "dateCompleted" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateCompleted": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "supplier.created": { "post": { "operationId": "supplier.created", "tags": [ "supplier-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.created" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.created" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "supplier.name.changed": { "post": { "operationId": "supplier.name.changed", "tags": [ "supplier-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.name.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.name.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "supplier.externalcode.changed": { "post": { "operationId": "supplier.externalcode.changed", "tags": [ "supplier-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.externalcode.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.externalcode.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "supplier.description.changed": { "post": { "operationId": "supplier.description.changed", "tags": [ "supplier-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.description.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.description.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "supplier.inactivated": { "post": { "operationId": "supplier.inactivated", "tags": [ "supplier-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.inactivated" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.inactivated" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "inactivatedDate": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "supplier.activated": { "post": { "operationId": "supplier.activated", "tags": [ "supplier-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.activated" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.activated" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "activatedDate": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "supplier.billingname.changed": { "post": { "operationId": "supplier.billingname.changed", "tags": [ "supplier-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.billingname.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.billingname.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "supplier.emailaddress.changed": { "post": { "operationId": "supplier.emailaddress.changed", "tags": [ "supplier-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.emailaddress.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.emailaddress.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "supplier.vettingstatus.changed": { "post": { "operationId": "supplier.vettingstatus.changed", "tags": [ "supplier-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.vettingstatus.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.vettingstatus.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "supplier.phonenumber.changed": { "post": { "operationId": "supplier.phonenumber.changed", "tags": [ "supplier-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.phonenumber.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.phonenumber.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "supplier.mailingaddress.changed": { "post": { "operationId": "supplier.mailingaddress.changed", "tags": [ "supplier-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.mailingaddress.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.mailingaddress.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "supplier.billingaddress.changed": { "post": { "operationId": "supplier.billingaddress.changed", "tags": [ "supplier-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.billingaddress.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.billingaddress.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "supplierlegalentity.created": { "post": { "operationId": "supplierlegalentity.created", "tags": [ "supplier-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplierlegalentity.created" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplierlegalentity.created" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "procurementLegalEntityId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "procurementLegalEntityId": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "supplierlegalentity.name.changed": { "post": { "operationId": "supplierlegalentity.name.changed", "tags": [ "supplier-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplierlegalentity.name.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplierlegalentity.name.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "procurementLegalEntityId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "procurementLegalEntityId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "supplierlegalentity.apcode.changed": { "post": { "operationId": "supplierlegalentity.apcode.changed", "tags": [ "supplier-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplierlegalentity.apcode.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplierlegalentity.apcode.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "procurementLegalEntityId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "procurementLegalEntityId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "supplierlegalentity.blanketponumber.changed": { "post": { "operationId": "supplierlegalentity.blanketponumber.changed", "tags": [ "supplier-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplierlegalentity.blanketponumber.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplierlegalentity.blanketponumber.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "procurementLegalEntityId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "procurementLegalEntityId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "webhook.ping": { "post": { "operationId": "webhook.ping", "tags": [ "webhook-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "webhook.ping" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "webhook.ping" ] }, "data": { "type": "object", "required": [ "webhookId" ], "properties": { "webhookId": { "type": "string", "format": "uuid" }, "pingTime": { "type": "string", "format": "date-time" } } } } } ] } } } } } }, "webhook.validation": { "post": { "operationId": "webhook.validation", "tags": [ "webhook-event-types" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "webhook.validation" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "webhook.validation" ] }, "data": { "type": "object", "properties": { "validationCode": { "type": "string" }, "validationUrl": { "type": "string", "format": "uri" } } } } } ] } } } } } } }, "components": { "parameters": { "client-site-id": { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, "api-version": { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } }, "skip": { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, "top": { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } }, "webhook-id": { "in": "path", "name": "webhookId", "description": "Uniquely identifies a webhook instance", "required": true, "schema": { "type": "string", "format": "uuid" } }, "event-id": { "in": "path", "name": "eventId", "description": "Uniquely identifies an event webhook instance", "required": true, "schema": { "type": "string", "format": "uuid" } }, "validation-code": { "in": "path", "name": "validationCode", "description": "The webhook validation code", "required": true, "schema": { "type": "string", "format": "uuid" } } }, "headers": { "rate-limit-limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "rate-limit-remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "rate-limit-reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } }, "retry-after": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "responses": { "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "409": { "description": "Conflict", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "400-inner": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "An Error Response.", "required": [ "error" ], "properties": { "error": { "type": "object", "description": "The Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." }, "details": { "type": "array", "description": "An array of details about specific errors that led to this reported error.", "items": { "type": "object", "description": "The Specific Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } }, "innerError": { "type": "object", "description": "An object containing more specific information than the current object about the error.", "properties": { "code": { "type": "string", "description": "A more specific error code than was provided by the containing error." }, "innerError": { "type": "object", "description": "The Inner Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } } } } } } } } } } }, "schemas": { "webhooks-array": { "type": "object", "description": "A list of webhooks", "properties": { "maxItems": { "type": "integer", "description": "The total number of webhooks" }, "value": { "type": "array", "description": "The set of webhooks. If there are no webhooks, this will be an empty array.", "items": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "hmac" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "hmac" ] }, "hmacSecret": { "type": "string", "description": "The secret to be used for the HMAC authentication, represented as a base64 encoded string", "maxLength": 255 } } } ] }, { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "oauth2" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "oauth2" ] }, "oauth2Domain": { "type": "string", "description": "The Domain used for Oauth2 authentication", "format": "url" }, "oauth2ClientId": { "type": "string", "description": "The Client ID used for Oauth2 authentication", "maxLength": 255 }, "oauth2ClientSecret": { "type": "string", "description": "The Client Secret used for Oauth2 authentication", "maxLength": 255 }, "oauth2Audience": { "type": "string", "description": "The Audience used for Oauth2 authentication", "maxLength": 255 }, "oauth2Scope": { "type": "string", "description": "The Scope used for Oauth2 authentication", "maxLength": 255 } } } ] } ] } } } }, "webhook-request": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "baseUri", "eventTypes" ], "properties": { "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } } } }, { "title": "hmac" }, { "type": "object", "required": [ "authType", "hmacSecret" ], "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "hmac" ] }, "hmacSecret": { "type": "string", "description": "The secret to be used for the HMAC authentication, represented as a base64 encoded string", "maxLength": 255 } } } ] }, { "allOf": [ { "type": "object", "required": [ "baseUri", "eventTypes" ], "properties": { "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } } } }, { "title": "oauth2" }, { "type": "object", "required": [ "authType", "oauth2Domain", "oauth2ClientId", "oauth2ClientSecret", "oauth2Audience" ], "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "oauth2" ] }, "oauth2Domain": { "type": "string", "description": "The Domain used for Oauth2 authentication", "format": "url" }, "oauth2ClientId": { "type": "string", "description": "The Client ID used for Oauth2 authentication", "maxLength": 255 }, "oauth2ClientSecret": { "type": "string", "description": "The Client Secret used for Oauth2 authentication", "maxLength": 255 }, "oauth2Audience": { "type": "string", "description": "The Audience used for Oauth2 authentication", "maxLength": 255 }, "oauth2Scope": { "type": "string", "description": "The Scope used for Oauth2 authentication", "maxLength": 255 } } } ] } ] }, "webhook-response": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "hmac" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "hmac" ] }, "hmacSecret": { "type": "string", "description": "The secret to be used for the HMAC authentication, represented as a base64 encoded string", "maxLength": 255 } } } ] }, { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "oauth2" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "oauth2" ] }, "oauth2Domain": { "type": "string", "description": "The Domain used for Oauth2 authentication", "format": "url" }, "oauth2ClientId": { "type": "string", "description": "The Client ID used for Oauth2 authentication", "maxLength": 255 }, "oauth2ClientSecret": { "type": "string", "description": "The Client Secret used for Oauth2 authentication", "maxLength": 255 }, "oauth2Audience": { "type": "string", "description": "The Audience used for Oauth2 authentication", "maxLength": 255 }, "oauth2Scope": { "type": "string", "description": "The Scope used for Oauth2 authentication", "maxLength": 255 } } } ] } ] }, "events-array": { "type": "object", "description": "A list of event webhook instances", "properties": { "maxItems": { "type": "integer", "description": "The total number of event webhook instances" }, "value": { "type": "array", "description": "The set of event webhook instances. If there are no items, this will be an empty array.", "items": { "type": "object", "properties": { "eventPayload": { "description": "The information about the event payload", "oneOf": [ { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amended" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amended" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "amendmentDate": { "type": "string", "format": "date-time" }, "amendmentTypeDetails": { "type": "array", "description": "List of field names changed on the assignment.", "items": { "type": "string" } } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendment.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendment.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendment.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendment.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendmentprocess.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendmentprocess.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "amendmentId", "processId", "processStatus", "message", "updateDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "amendmentId": { "type": "string", "format": "uuid" }, "processId": { "type": "string", "format": "uuid" }, "processStatus": { "type": "string", "enum": [ "Received", "Running", "Success", "Error" ] }, "message": { "type": "string" }, "updateDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.detailchanged" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.detailchanged" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "changedDate": { "type": "string", "format": "date-time" }, "amendmentTypeDetails": { "type": "array", "description": "List of field names changed on the assignment.", "items": { "type": "string" } }, "changedClientDefinedFields": { "type": "array", "description": "List of client defined field names changed on the assignment.", "items": { "type": "string" } } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.didnotshow" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.didnotshow" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "noShowDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.expired" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.expired" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "expiredDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extended" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extended" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "extendedDate": { "type": [ "string", "null" ], "format": "date-time" }, "endDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extension.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extension.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extension.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extension.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.group.extension.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.group.extension.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentIds", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.imported" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.imported" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "candidateId": { "type": [ "string", "null" ], "format": "uuid" }, "dateImported": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "candidateId": { "type": [ "string", "null" ], "format": "uuid" }, "startDate": { "type": "string", "format": "date" }, "dateScheduled": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.started" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.started" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "startedDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.terminated" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.terminated" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "terminationDate": { "type": [ "string", "null" ], "format": "date-time" }, "terminationReason": { "type": [ "string", "null" ] } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.termination.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.termination.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.termination.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.termination.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "bid.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bid.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "bidId", "statusId", "dateSubmitted" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "bidId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateSubmitted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateCancelled": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.hm.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.hm.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateCancelled": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateCompleted": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.pending.msp.approval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.pending.msp.approval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.qualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.qualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateQualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.requested" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.requested" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRequested": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.required" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.required" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRequired": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateScheduled": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.msp.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.msp.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.msp.qualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.msp.qualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateQualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.accepted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.accepted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateAccepted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.started" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.started" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateStarted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.withdrawn" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.withdrawn" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateWithdrawn": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.onboarded" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.onboarded" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateOnboarded": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.background.checks" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.background.checks" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.confirmation" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.confirmation" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.onboarding" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.onboarding" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.onboarding.processing" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.onboarding.processing" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.submission" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.submission" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.ready.for.offer" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.ready.for.offer" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateReadyForOffer": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.resume.added" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.resume.added" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "attachmentId", "dateAdded" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "attachmentId": { "type": "string", "format": "uuid" }, "dateAdded": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.resume.removed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.resume.removed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "attachmentId", "dateRemoved" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "attachmentId": { "type": "string", "format": "uuid" }, "dateRemoved": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.selected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.selected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateSelected": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateSubmitted": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.withdrawn" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.withdrawn" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateWithdrawn": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "invoice.finalinvoice.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "invoice.finalinvoice.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "invoiceId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "integer", "example": 1000 }, "categoryName": { "type": "string", "example": "US Staff Aug Final Time" }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" }, "invoiceProcessDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "invoice.retrieved" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "invoice.retrieved" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "invoiceId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "integer", "example": 1000 }, "paymentType": { "type": "string", "enum": [ "staffAugTimesheet", "staffAugExpense", "staffAugMiscFee", "projectServiceTimesheet", "projectServiceMiscFee", "projectServiceMilestone", "projectServiceExpense" ] }, "skip": { "type": "integer", "example": 10 }, "pageSize": { "type": "integer", "example": 20 }, "maxItems": { "type": "integer", "example": 500 }, "dateRetrieved": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "dateRejected" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "dateScheduled" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "dateScheduled": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": [ "string" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.edited" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.edited" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId", "editedDate", "editedFields", "editedClientDefinedFields" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "editedDate": { "type": [ "string" ], "format": "date-time" }, "editedFields": { "type": "array", "description": "List of field names edited on the request.", "items": { "type": "string", "enum": [ "EndDate", "EstimatedCost", "EstimatedExpense", "HoursPerWeek", "Quantity", "ReasonForRequest", "StartDate" ] } }, "editedClientDefinedFields": { "type": "array", "description": "List of client defined field names edited on the request.", "items": { "type": "string" } } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.filled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.filled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "totalPositionsFilled": { "type": "integer" }, "filledDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.group.edited" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.group.edited" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestIds", "editedDate", "editedFields" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "editedDate": { "type": [ "string" ], "format": "date-time" }, "editedFields": { "type": "array", "description": "List of field names edited on the request group.", "items": { "type": "string", "enum": [ "AdminCostCenter", "BillToCostCenter", "HiringManager", "PhysicalWorkLocation", "TaxLocation" ] } } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.opened" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.opened" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "dateOpened": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.placedonhold" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.placedonhold" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "datePlacedOnHold": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.releasedtosupplier" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.releasedtosupplier" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId", "supplierId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "supplierId": { "type": "string", "format": "uuid" }, "releasedToSupplierDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.reopened" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.reopened" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "dateReOpened": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "requestSubmitted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.attachment.added" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.attachment.added" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "persona", "attachmentId", "sowSection", "dateAdded" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "persona": { "type": "string", "description": "Identifies whether the detail the attachment was added to was created by the client or vendor. Attachment changes made to details created by the vendor will not be readily available to client access until the statement of work has been submitted back to the client for approval.\n", "enum": [ "client", "vendor" ] }, "attachmentId": { "type": "string", "format": "uuid" }, "sowSection": { "type": "string", "description": "Section of the SOW where the attachment was added.", "enum": [ "sowGeneral", "sowTerms" ] }, "dateAdded": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.attachment.removed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.attachment.removed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "persona", "attachmentId", "sowSection", "dateRemoved" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "persona": { "type": "string", "description": "Identifies whether the detail the attachment was removed from was created by the client or vendor. Attachment changes made to details created by the vendor will not be readily available to client access until the statement of work has been submitted back to the client for approval.\n", "enum": [ "client", "vendor" ] }, "attachmentId": { "type": "string", "format": "uuid" }, "sowSection": { "type": "string", "description": "Section of the SOW where the attachment was removed.", "enum": [ "sowGeneral", "sowTerms" ] }, "dateRemoved": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendingclientapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendingclientapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendingfinalapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendingfinalapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendinginitialapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendinginitialapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.readytonegotiate" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.readytonegotiate" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "dateReady" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateReady": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.sourcingcomplete" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.sourcingcomplete" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "dateCompleted" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateCompleted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "timesheet.submittedforapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "timesheet.submittedforapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "timesheetId", "submitDate", "sourceType" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "timesheetId": { "type": "string", "format": "uuid" }, "submitDate": { "type": "string", "format": "date-time" }, "sourceType": { "type": "string", "enum": [ "Api", "Application", "Import", "Mobile", "WebImport" ] } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "webhook.ping" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "webhook.ping" ] }, "data": { "type": "object", "required": [ "webhookId" ], "properties": { "webhookId": { "type": "string", "format": "uuid" }, "pingTime": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "webhook.validation" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "webhook.validation" ] }, "data": { "type": "object", "properties": { "validationCode": { "type": "string" }, "validationUrl": { "type": "string", "format": "uri" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.beelineuniqueid.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.beelineuniqueid.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.email.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.email.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.externalid.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.externalid.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.name.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.name.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.phonenumber.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.phonenumber.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.username.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.username.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } ] }, "attempts": { "description": "The data for all attempts to send the event to the webhook endpoint", "type": "array", "items": { "type": "object", "properties": { "attemptTime": { "type": "string", "description": "The timestamp for the attempt", "format": "date-time" }, "responseCode": { "type": "string", "description": "The response code from the webhook endpoint" }, "message": { "type": "string", "description": "The status message of the attempt" } } } } } } } } }, "event-detail": { "type": "object", "properties": { "eventPayload": { "description": "The information about the event payload", "oneOf": [ { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amended" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amended" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "amendmentDate": { "type": "string", "format": "date-time" }, "amendmentTypeDetails": { "type": "array", "description": "List of field names changed on the assignment.", "items": { "type": "string" } } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendment.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendment.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendment.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendment.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendmentprocess.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendmentprocess.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "amendmentId", "processId", "processStatus", "message", "updateDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "amendmentId": { "type": "string", "format": "uuid" }, "processId": { "type": "string", "format": "uuid" }, "processStatus": { "type": "string", "enum": [ "Received", "Running", "Success", "Error" ] }, "message": { "type": "string" }, "updateDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.detailchanged" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.detailchanged" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "changedDate": { "type": "string", "format": "date-time" }, "amendmentTypeDetails": { "type": "array", "description": "List of field names changed on the assignment.", "items": { "type": "string" } }, "changedClientDefinedFields": { "type": "array", "description": "List of client defined field names changed on the assignment.", "items": { "type": "string" } } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.didnotshow" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.didnotshow" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "noShowDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.expired" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.expired" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "expiredDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extended" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extended" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "extendedDate": { "type": [ "string", "null" ], "format": "date-time" }, "endDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extension.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extension.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extension.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extension.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.group.extension.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.group.extension.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentIds", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.imported" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.imported" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "candidateId": { "type": [ "string", "null" ], "format": "uuid" }, "dateImported": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "candidateId": { "type": [ "string", "null" ], "format": "uuid" }, "startDate": { "type": "string", "format": "date" }, "dateScheduled": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.started" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.started" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "startedDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.terminated" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.terminated" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "terminationDate": { "type": [ "string", "null" ], "format": "date-time" }, "terminationReason": { "type": [ "string", "null" ] } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.termination.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.termination.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.termination.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.termination.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "bid.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bid.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "bidId", "statusId", "dateSubmitted" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "bidId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateSubmitted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateCancelled": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.hm.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.hm.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateCancelled": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateCompleted": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.pending.msp.approval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.pending.msp.approval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.qualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.qualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateQualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.requested" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.requested" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRequested": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.required" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.required" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRequired": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateScheduled": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.msp.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.msp.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.msp.qualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.msp.qualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateQualified": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.accepted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.accepted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateAccepted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.started" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.started" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateStarted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.withdrawn" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.withdrawn" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateWithdrawn": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.onboarded" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.onboarded" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateOnboarded": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.background.checks" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.background.checks" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.confirmation" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.confirmation" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.onboarding" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.onboarding" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.onboarding.processing" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.onboarding.processing" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.submission" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.submission" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.ready.for.offer" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.ready.for.offer" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateReadyForOffer": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.resume.added" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.resume.added" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "attachmentId", "dateAdded" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "attachmentId": { "type": "string", "format": "uuid" }, "dateAdded": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.resume.removed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.resume.removed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "attachmentId", "dateRemoved" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "attachmentId": { "type": "string", "format": "uuid" }, "dateRemoved": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.selected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.selected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateSelected": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateSubmitted": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.withdrawn" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.withdrawn" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateWithdrawn": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "invoice.finalinvoice.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "invoice.finalinvoice.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "invoiceId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "integer", "example": 1000 }, "categoryName": { "type": "string", "example": "US Staff Aug Final Time" }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" }, "invoiceProcessDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "invoice.retrieved" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "invoice.retrieved" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "invoiceId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "integer", "example": 1000 }, "paymentType": { "type": "string", "enum": [ "staffAugTimesheet", "staffAugExpense", "staffAugMiscFee", "projectServiceTimesheet", "projectServiceMiscFee", "projectServiceMilestone", "projectServiceExpense" ] }, "skip": { "type": "integer", "example": 10 }, "pageSize": { "type": "integer", "example": 20 }, "maxItems": { "type": "integer", "example": 500 }, "dateRetrieved": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "dateRejected" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "dateScheduled" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "dateScheduled": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": [ "string" ], "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.edited" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.edited" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId", "editedDate", "editedFields", "editedClientDefinedFields" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "editedDate": { "type": [ "string" ], "format": "date-time" }, "editedFields": { "type": "array", "description": "List of field names edited on the request.", "items": { "type": "string", "enum": [ "EndDate", "EstimatedCost", "EstimatedExpense", "HoursPerWeek", "Quantity", "ReasonForRequest", "StartDate" ] } }, "editedClientDefinedFields": { "type": "array", "description": "List of client defined field names edited on the request.", "items": { "type": "string" } } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.filled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.filled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "totalPositionsFilled": { "type": "integer" }, "filledDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.group.edited" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.group.edited" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestIds", "editedDate", "editedFields" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "editedDate": { "type": [ "string" ], "format": "date-time" }, "editedFields": { "type": "array", "description": "List of field names edited on the request group.", "items": { "type": "string", "enum": [ "AdminCostCenter", "BillToCostCenter", "HiringManager", "PhysicalWorkLocation", "TaxLocation" ] } } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.opened" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.opened" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "dateOpened": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.placedonhold" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.placedonhold" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "datePlacedOnHold": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.releasedtosupplier" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.releasedtosupplier" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId", "supplierId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "supplierId": { "type": "string", "format": "uuid" }, "releasedToSupplierDate": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.reopened" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.reopened" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "dateReOpened": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "requestSubmitted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.attachment.added" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.attachment.added" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "persona", "attachmentId", "sowSection", "dateAdded" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "persona": { "type": "string", "description": "Identifies whether the detail the attachment was added to was created by the client or vendor. Attachment changes made to details created by the vendor will not be readily available to client access until the statement of work has been submitted back to the client for approval.\n", "enum": [ "client", "vendor" ] }, "attachmentId": { "type": "string", "format": "uuid" }, "sowSection": { "type": "string", "description": "Section of the SOW where the attachment was added.", "enum": [ "sowGeneral", "sowTerms" ] }, "dateAdded": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.attachment.removed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.attachment.removed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "persona", "attachmentId", "sowSection", "dateRemoved" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "persona": { "type": "string", "description": "Identifies whether the detail the attachment was removed from was created by the client or vendor. Attachment changes made to details created by the vendor will not be readily available to client access until the statement of work has been submitted back to the client for approval.\n", "enum": [ "client", "vendor" ] }, "attachmentId": { "type": "string", "format": "uuid" }, "sowSection": { "type": "string", "description": "Section of the SOW where the attachment was removed.", "enum": [ "sowGeneral", "sowTerms" ] }, "dateRemoved": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendingclientapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendingclientapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendingfinalapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendingfinalapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendinginitialapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendinginitialapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.readytonegotiate" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.readytonegotiate" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "dateReady" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateReady": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.sourcingcomplete" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.sourcingcomplete" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "dateCompleted" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateCompleted": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "timesheet.submittedforapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "timesheet.submittedforapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "timesheetId", "submitDate", "sourceType" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "timesheetId": { "type": "string", "format": "uuid" }, "submitDate": { "type": "string", "format": "date-time" }, "sourceType": { "type": "string", "enum": [ "Api", "Application", "Import", "Mobile", "WebImport" ] } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "webhook.ping" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "webhook.ping" ] }, "data": { "type": "object", "required": [ "webhookId" ], "properties": { "webhookId": { "type": "string", "format": "uuid" }, "pingTime": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "webhook.validation" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "webhook.validation" ] }, "data": { "type": "object", "properties": { "validationCode": { "type": "string" }, "validationUrl": { "type": "string", "format": "uri" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.beelineuniqueid.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.beelineuniqueid.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.email.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.email.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.externalid.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.externalid.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.name.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.name.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.phonenumber.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.phonenumber.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.username.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.username.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] } ] }, "attempts": { "description": "The data for all attempts to send the event to the webhook endpoint", "type": "array", "items": { "type": "object", "properties": { "attemptTime": { "type": "string", "description": "The timestamp for the attempt", "format": "date-time" }, "responseCode": { "type": "string", "description": "The response code from the webhook endpoint" }, "message": { "type": "string", "description": "The status message of the attempt" } } } } } }, "webhook.validation": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "webhook.validation" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "webhook.validation" ] }, "data": { "type": "object", "properties": { "validationCode": { "type": "string" }, "validationUrl": { "type": "string", "format": "uri" } } } } } ] }, "webhook.ping": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "webhook.ping" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "webhook.ping" ] }, "data": { "type": "object", "required": [ "webhookId" ], "properties": { "webhookId": { "type": "string", "format": "uuid" }, "pingTime": { "type": "string", "format": "date-time" } } } } } ] }, "assignment.started": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.started" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.started" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "startedDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "assignment.imported": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.imported" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.imported" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "candidateId": { "type": [ "string", "null" ], "format": "uuid" }, "dateImported": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "assignment.scheduled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "candidateId": { "type": [ "string", "null" ], "format": "uuid" }, "startDate": { "type": "string", "format": "date" }, "dateScheduled": { "type": "string", "format": "date-time" } } } } } ] }, "assignment.terminated": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.terminated" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.terminated" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "terminationDate": { "type": [ "string", "null" ], "format": "date-time" }, "terminationReason": { "type": [ "string", "null" ] } } } } } ] }, "assignment.expired": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.expired" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.expired" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "expiredDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "assignment.cancelled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "assignment.detailchanged": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.detailchanged" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.detailchanged" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "changedDate": { "type": "string", "format": "date-time" }, "amendmentTypeDetails": { "type": "array", "description": "List of field names changed on the assignment.", "items": { "type": "string" } }, "changedClientDefinedFields": { "type": "array", "description": "List of client defined field names changed on the assignment.", "items": { "type": "string" } } } } } } ] }, "assignment.didnotshow": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.didnotshow" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.didnotshow" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "noShowDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "assignment.extended": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extended" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extended" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "extendedDate": { "type": [ "string", "null" ], "format": "date-time" }, "endDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "assignment.extension.cancelled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extension.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extension.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, "assignment.extension.rejected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extension.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extension.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, "assignment.group.extension.rejected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.group.extension.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.group.extension.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentIds", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, "assignment.amended": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amended" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amended" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "amendmentDate": { "type": "string", "format": "date-time" }, "amendmentTypeDetails": { "type": "array", "description": "List of field names changed on the assignment.", "items": { "type": "string" } } } } } } ] }, "assignment.amendment.cancelled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendment.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendment.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, "assignment.amendment.rejected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendment.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendment.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, "assignment.amendmentprocess.completed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendmentprocess.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendmentprocess.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "amendmentId", "processId", "processStatus", "message", "updateDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "amendmentId": { "type": "string", "format": "uuid" }, "processId": { "type": "string", "format": "uuid" }, "processStatus": { "type": "string", "enum": [ "Received", "Running", "Success", "Error" ] }, "message": { "type": "string" }, "updateDate": { "type": "string", "format": "date-time" } } } } } ] }, "assignment.termination.cancelled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.termination.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.termination.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, "assignment.termination.rejected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.termination.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.termination.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, "bid.submitted": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "bid.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bid.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "bidId", "statusId", "dateSubmitted" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "bidId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateSubmitted": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.cancelled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateCancelled": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.disqualified": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.hm.disqualified": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.hm.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.hm.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.interview.cancelled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateCancelled": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "candidate.interview.completed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateCompleted": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "candidate.interview.pending": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.interview.pending.msp.approval": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.pending.msp.approval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.pending.msp.approval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.interview.qualified": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.qualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.qualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateQualified": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.interview.rejected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.interview.requested": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.requested" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.requested" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRequested": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "candidate.interview.required": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.required" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.required" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRequired": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.interview.scheduled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateScheduled": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "candidate.msp.disqualified": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.msp.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.msp.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.msp.qualified": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.msp.qualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.msp.qualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateQualified": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.offer.accepted": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.accepted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.accepted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateAccepted": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.offer.pending": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.offer.rejected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.offer.started": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.started" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.started" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateStarted": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.offer.withdrawn": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.withdrawn" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.withdrawn" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateWithdrawn": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.onboarded": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.onboarded" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.onboarded" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateOnboarded": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.pending.background.checks": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.background.checks" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.background.checks" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.pending.confirmation": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.confirmation" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.confirmation" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.pending.onboarding": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.onboarding" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.onboarding" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.pending.onboarding.processing": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.onboarding.processing" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.onboarding.processing" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.pending.submission": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.submission" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.submission" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.ready.for.offer": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.ready.for.offer" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.ready.for.offer" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateReadyForOffer": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.rejected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "candidate.resume.added": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.resume.added" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.resume.added" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "attachmentId", "dateAdded" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "attachmentId": { "type": "string", "format": "uuid" }, "dateAdded": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.resume.removed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.resume.removed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.resume.removed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "attachmentId", "dateRemoved" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "attachmentId": { "type": "string", "format": "uuid" }, "dateRemoved": { "type": "string", "format": "date-time" } } } } } ] }, "candidate.selected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.selected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.selected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateSelected": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "candidate.submitted": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateSubmitted": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "candidate.withdrawn": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.withdrawn" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.withdrawn" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateWithdrawn": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "invoice.finalinvoice.completed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "invoice.finalinvoice.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "invoice.finalinvoice.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "invoiceId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "integer", "example": 1000 }, "categoryName": { "type": "string", "example": "US Staff Aug Final Time" }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" }, "invoiceProcessDate": { "type": "string", "format": "date-time" } } } } } ] }, "invoice.retrieved": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "invoice.retrieved" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "invoice.retrieved" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "invoiceId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "integer", "example": 1000 }, "paymentType": { "type": "string", "enum": [ "staffAugTimesheet", "staffAugExpense", "staffAugMiscFee", "projectServiceTimesheet", "projectServiceMiscFee", "projectServiceMilestone", "projectServiceExpense" ] }, "skip": { "type": "integer", "example": 10 }, "pageSize": { "type": "integer", "example": 20 }, "maxItems": { "type": "integer", "example": 500 }, "dateRetrieved": { "type": "string", "format": "date-time" } } } } } ] }, "project.milestone.payment.pending": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "project.milestone.payment.rejected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "dateRejected" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, "project.milestone.payment.scheduled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "dateScheduled" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "dateScheduled": { "type": "string", "format": "date-time" } } } } } ] }, "request.cancelled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": [ "string" ], "format": "date-time" } } } } } ] }, "request.edited": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.edited" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.edited" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId", "editedDate", "editedFields", "editedClientDefinedFields" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "editedDate": { "type": [ "string" ], "format": "date-time" }, "editedFields": { "type": "array", "description": "List of field names edited on the request.", "items": { "type": "string", "enum": [ "EndDate", "EstimatedCost", "EstimatedExpense", "HoursPerWeek", "Quantity", "ReasonForRequest", "StartDate" ] } }, "editedClientDefinedFields": { "type": "array", "description": "List of client defined field names edited on the request.", "items": { "type": "string" } } } } } } ] }, "request.filled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.filled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.filled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "totalPositionsFilled": { "type": "integer" }, "filledDate": { "type": "string", "format": "date-time" } } } } } ] }, "request.group.edited": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.group.edited" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.group.edited" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestIds", "editedDate", "editedFields" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "editedDate": { "type": [ "string" ], "format": "date-time" }, "editedFields": { "type": "array", "description": "List of field names edited on the request group.", "items": { "type": "string", "enum": [ "AdminCostCenter", "BillToCostCenter", "HiringManager", "PhysicalWorkLocation", "TaxLocation" ] } } } } } } ] }, "request.opened": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.opened" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.opened" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "dateOpened": { "type": "string", "format": "date-time" } } } } } ] }, "request.placedonhold": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.placedonhold" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.placedonhold" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "datePlacedOnHold": { "type": "string", "format": "date-time" } } } } } ] }, "request.releasedtosupplier": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.releasedtosupplier" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.releasedtosupplier" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId", "supplierId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "supplierId": { "type": "string", "format": "uuid" }, "releasedToSupplierDate": { "type": "string", "format": "date-time" } } } } } ] }, "request.reopened": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.reopened" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.reopened" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "dateReOpened": { "type": "string", "format": "date-time" } } } } } ] }, "request.submitted": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "requestSubmitted": { "type": "string", "format": "date-time" } } } } } ] }, "sow.attachment.added": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.attachment.added" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.attachment.added" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "persona", "attachmentId", "sowSection", "dateAdded" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "persona": { "type": "string", "description": "Identifies whether the detail the attachment was added to was created by the client or vendor. Attachment changes made to details created by the vendor will not be readily available to client access until the statement of work has been submitted back to the client for approval.\n", "enum": [ "client", "vendor" ] }, "attachmentId": { "type": "string", "format": "uuid" }, "sowSection": { "type": "string", "description": "Section of the SOW where the attachment was added.", "enum": [ "sowGeneral", "sowTerms" ] }, "dateAdded": { "type": "string", "format": "date-time" } } } } } ] }, "sow.attachment.removed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.attachment.removed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.attachment.removed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "persona", "attachmentId", "sowSection", "dateRemoved" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "persona": { "type": "string", "description": "Identifies whether the detail the attachment was removed from was created by the client or vendor. Attachment changes made to details created by the vendor will not be readily available to client access until the statement of work has been submitted back to the client for approval.\n", "enum": [ "client", "vendor" ] }, "attachmentId": { "type": "string", "format": "uuid" }, "sowSection": { "type": "string", "description": "Section of the SOW where the attachment was removed.", "enum": [ "sowGeneral", "sowTerms" ] }, "dateRemoved": { "type": "string", "format": "date-time" } } } } } ] }, "sow.pendingclientapproval": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendingclientapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendingclientapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "sow.pendingfinalapproval": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendingfinalapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendingfinalapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "sow.pendinginitialapproval": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendinginitialapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendinginitialapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "sow.readytonegotiate": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.readytonegotiate" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.readytonegotiate" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "dateReady" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateReady": { "type": "string", "format": "date-time" } } } } } ] }, "sow.sourcingcomplete": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.sourcingcomplete" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.sourcingcomplete" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "dateCompleted" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateCompleted": { "type": "string", "format": "date-time" } } } } } ] }, "supplier.created": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.created" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.created" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" } } } } } ] }, "supplier.name.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.name.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.name.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplier.externalcode.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.externalcode.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.externalcode.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplier.description.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.description.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.description.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplier.inactivated": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.inactivated" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.inactivated" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "inactivatedDate": { "type": "string", "format": "date-time" } } } } } ] }, "supplier.activated": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.activated" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.activated" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "activatedDate": { "type": "string", "format": "date-time" } } } } } ] }, "supplier.billingname.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.billingname.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.billingname.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplier.emailaddress.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.emailaddress.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.emailaddress.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplier.vettingstatus.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.vettingstatus.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.vettingstatus.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplier.phonenumber.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.phonenumber.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.phonenumber.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplier.mailingaddress.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.mailingaddress.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.mailingaddress.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplier.billingaddress.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.billingaddress.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.billingaddress.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplierlegalentity.created": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplierlegalentity.created" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplierlegalentity.created" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "procurementLegalEntityId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "procurementLegalEntityId": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" } } } } } ] }, "supplierlegalentity.name.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplierlegalentity.name.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplierlegalentity.name.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "procurementLegalEntityId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "procurementLegalEntityId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplierlegalentity.apcode.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplierlegalentity.apcode.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplierlegalentity.apcode.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "procurementLegalEntityId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "procurementLegalEntityId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplierlegalentity.blanketponumber.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplierlegalentity.blanketponumber.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplierlegalentity.blanketponumber.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "procurementLegalEntityId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "procurementLegalEntityId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "timesheet.submittedforapproval": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "timesheet.submittedforapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "timesheet.submittedforapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "timesheetId", "submitDate", "sourceType" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "timesheetId": { "type": "string", "format": "uuid" }, "submitDate": { "type": "string", "format": "date-time" }, "sourceType": { "type": "string", "enum": [ "Api", "Application", "Import", "Mobile", "WebImport" ] } } } } } ] }, "worker.name.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.name.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.name.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "worker.username.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.username.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.username.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "worker.phonenumber.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.phonenumber.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.phonenumber.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "worker.beelineuniqueid.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.beelineuniqueid.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.beelineuniqueid.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "worker.email.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.email.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.email.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "worker.externalid.changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.externalid.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.externalid.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "event-types": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] }, "webhook-response-base": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, "webhook-response-hmac": { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "hmac" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "hmac" ] }, "hmacSecret": { "type": "string", "description": "The secret to be used for the HMAC authentication, represented as a base64 encoded string", "maxLength": 255 } } } ] }, "webhook-response-oauth2": { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "oauth2" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "oauth2" ] }, "oauth2Domain": { "type": "string", "description": "The Domain used for Oauth2 authentication", "format": "url" }, "oauth2ClientId": { "type": "string", "description": "The Client ID used for Oauth2 authentication", "maxLength": 255 }, "oauth2ClientSecret": { "type": "string", "description": "The Client Secret used for Oauth2 authentication", "maxLength": 255 }, "oauth2Audience": { "type": "string", "description": "The Audience used for Oauth2 authentication", "maxLength": 255 }, "oauth2Scope": { "type": "string", "description": "The Scope used for Oauth2 authentication", "maxLength": 255 } } } ] }, "webhook-response-model": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "hmac" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "hmac" ] }, "hmacSecret": { "type": "string", "description": "The secret to be used for the HMAC authentication, represented as a base64 encoded string", "maxLength": 255 } } } ] }, { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the webhook", "format": "uuid" }, "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } }, "status": { "type": "string", "description": "The status of the webhook subscription.", "enum": [ "pending", "active", "inactive" ] }, "validationCode": { "type": "string", "description": "The validation code for the webhook", "format": "uuid" } } }, { "title": "oauth2" }, { "type": "object", "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "oauth2" ] }, "oauth2Domain": { "type": "string", "description": "The Domain used for Oauth2 authentication", "format": "url" }, "oauth2ClientId": { "type": "string", "description": "The Client ID used for Oauth2 authentication", "maxLength": 255 }, "oauth2ClientSecret": { "type": "string", "description": "The Client Secret used for Oauth2 authentication", "maxLength": 255 }, "oauth2Audience": { "type": "string", "description": "The Audience used for Oauth2 authentication", "maxLength": 255 }, "oauth2Scope": { "type": "string", "description": "The Scope used for Oauth2 authentication", "maxLength": 255 } } } ] } ] }, "error": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } }, "error-response": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "empty-response": { "type": "null" }, "webhook-request-base": { "type": "object", "required": [ "baseUri", "eventTypes" ], "properties": { "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } } } }, "webhook-request-hmac": { "allOf": [ { "type": "object", "required": [ "baseUri", "eventTypes" ], "properties": { "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } } } }, { "title": "hmac" }, { "type": "object", "required": [ "authType", "hmacSecret" ], "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "hmac" ] }, "hmacSecret": { "type": "string", "description": "The secret to be used for the HMAC authentication, represented as a base64 encoded string", "maxLength": 255 } } } ] }, "webhook-request-oauth2": { "allOf": [ { "type": "object", "required": [ "baseUri", "eventTypes" ], "properties": { "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } } } }, { "title": "oauth2" }, { "type": "object", "required": [ "authType", "oauth2Domain", "oauth2ClientId", "oauth2ClientSecret", "oauth2Audience" ], "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "oauth2" ] }, "oauth2Domain": { "type": "string", "description": "The Domain used for Oauth2 authentication", "format": "url" }, "oauth2ClientId": { "type": "string", "description": "The Client ID used for Oauth2 authentication", "maxLength": 255 }, "oauth2ClientSecret": { "type": "string", "description": "The Client Secret used for Oauth2 authentication", "maxLength": 255 }, "oauth2Audience": { "type": "string", "description": "The Audience used for Oauth2 authentication", "maxLength": 255 }, "oauth2Scope": { "type": "string", "description": "The Scope used for Oauth2 authentication", "maxLength": 255 } } } ] }, "webhook-request-model": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "baseUri", "eventTypes" ], "properties": { "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } } } }, { "title": "hmac" }, { "type": "object", "required": [ "authType", "hmacSecret" ], "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "hmac" ] }, "hmacSecret": { "type": "string", "description": "The secret to be used for the HMAC authentication, represented as a base64 encoded string", "maxLength": 255 } } } ] }, { "allOf": [ { "type": "object", "required": [ "baseUri", "eventTypes" ], "properties": { "baseUri": { "type": "string", "description": "The webhook endpoint web address", "format": "uri" }, "eventTypes": { "type": "array", "description": "The list of event types subscribed to by the webhook", "items": { "type": "string", "description": "The type of webhook event.", "enum": [ "assignment.amended", "assignment.amendment.cancelled", "assignment.amendment.rejected", "assignment.amendmentprocess.completed", "assignment.cancelled", "assignment.detailchanged", "assignment.didnotshow", "assignment.expired", "assignment.extended", "assignment.extension.cancelled", "assignment.extension.rejected", "assignment.group.extension.rejected", "assignment.imported", "assignment.scheduled", "assignment.started", "assignment.terminated", "assignment.termination.cancelled", "assignment.termination.rejected", "bid.submitted", "candidate.cancelled", "candidate.disqualified", "candidate.hm.disqualified", "candidate.interview.cancelled", "candidate.interview.completed", "candidate.interview.pending", "candidate.interview.pending.msp.approval", "candidate.interview.qualified", "candidate.interview.rejected", "candidate.interview.requested", "candidate.interview.required", "candidate.interview.scheduled", "candidate.msp.disqualified", "candidate.msp.qualified", "candidate.offer.accepted", "candidate.offer.pending", "candidate.offer.rejected", "candidate.offer.started", "candidate.offer.withdrawn", "candidate.onboarded", "candidate.pending.background.checks", "candidate.pending.confirmation", "candidate.pending.onboarding", "candidate.pending.onboarding.processing", "candidate.pending.submission", "candidate.ready.for.offer", "candidate.rejected", "candidate.resume.added", "candidate.resume.removed", "candidate.selected", "candidate.submitted", "candidate.withdrawn", "invoice.finalinvoice.completed", "invoice.retrieved", "project.milestone.payment.pending", "project.milestone.payment.rejected", "project.milestone.payment.scheduled", "request.cancelled", "request.edited", "request.filled", "request.group.edited", "request.opened", "request.placedonhold", "request.releasedtosupplier", "request.reopened", "request.submitted", "sow.attachment.added", "sow.attachment.removed", "sow.pendingclientapproval", "sow.pendingfinalapproval", "sow.pendinginitialapproval", "sow.readytonegotiate", "sow.sourcingcomplete", "supplier.created", "supplier.name.changed", "supplier.externalcode.changed", "supplier.description.changed", "supplier.inactivated", "supplier.activated", "supplier.billingname.changed", "supplier.emailaddress.changed", "supplier.vettingstatus.changed", "supplier.phonenumber.changed", "supplier.mailingaddress.changed", "supplier.billingaddress.changed", "supplierlegalentity.created", "supplierlegalentity.name.changed", "supplierlegalentity.apcode.changed", "supplierlegalentity.blanketponumber.changed", "timesheet.submittedforapproval", "worker.beelineuniqueid.changed", "worker.email.changed", "worker.externalid.changed", "worker.name.changed", "worker.phonenumber.changed", "worker.username.changed" ] } } } }, { "title": "oauth2" }, { "type": "object", "required": [ "authType", "oauth2Domain", "oauth2ClientId", "oauth2ClientSecret", "oauth2Audience" ], "properties": { "authType": { "type": "string", "description": "The authentication type used by the webhook endpoint", "enum": [ "oauth2" ] }, "oauth2Domain": { "type": "string", "description": "The Domain used for Oauth2 authentication", "format": "url" }, "oauth2ClientId": { "type": "string", "description": "The Client ID used for Oauth2 authentication", "maxLength": 255 }, "oauth2ClientSecret": { "type": "string", "description": "The Client Secret used for Oauth2 authentication", "maxLength": 255 }, "oauth2Audience": { "type": "string", "description": "The Audience used for Oauth2 authentication", "maxLength": 255 }, "oauth2Scope": { "type": "string", "description": "The Scope used for Oauth2 authentication", "maxLength": 255 } } } ] } ] }, "webhook-event-base": { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, "assignment-amended": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amended" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amended" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "amendmentDate": { "type": "string", "format": "date-time" }, "amendmentTypeDetails": { "type": "array", "description": "List of field names changed on the assignment.", "items": { "type": "string" } } } } } } ] }, "assignment-amendment-cancelled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendment.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendment.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, "assignment-amendment-rejected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendment.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendment.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, "assignment-amendmentprocess-completed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.amendmentprocess.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.amendmentprocess.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "amendmentId", "processId", "processStatus", "message", "updateDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "amendmentId": { "type": "string", "format": "uuid" }, "processId": { "type": "string", "format": "uuid" }, "processStatus": { "type": "string", "enum": [ "Received", "Running", "Success", "Error" ] }, "message": { "type": "string" }, "updateDate": { "type": "string", "format": "date-time" } } } } } ] }, "assignment-cancelled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "assignment-detailchanged": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.detailchanged" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.detailchanged" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "changedDate": { "type": "string", "format": "date-time" }, "amendmentTypeDetails": { "type": "array", "description": "List of field names changed on the assignment.", "items": { "type": "string" } }, "changedClientDefinedFields": { "type": "array", "description": "List of client defined field names changed on the assignment.", "items": { "type": "string" } } } } } } ] }, "assignment-didnotshow": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.didnotshow" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.didnotshow" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "noShowDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "assignment-expired": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.expired" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.expired" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "expiredDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "assignment-extended": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extended" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extended" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "extendedDate": { "type": [ "string", "null" ], "format": "date-time" }, "endDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "assignment-extension-cancelled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extension.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extension.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, "assignment-extension-rejected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.extension.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.extension.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, "assignment-group-extension-rejected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.group.extension.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.group.extension.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentIds", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, "assignment-imported": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.imported" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.imported" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "candidateId": { "type": [ "string", "null" ], "format": "uuid" }, "dateImported": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "assignment-scheduled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "candidateId": { "type": [ "string", "null" ], "format": "uuid" }, "startDate": { "type": "string", "format": "date" }, "dateScheduled": { "type": "string", "format": "date-time" } } } } } ] }, "assignment-started": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.started" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.started" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "startedDate": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "assignment-terminated": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.terminated" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.terminated" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "assignmentId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "terminationDate": { "type": [ "string", "null" ], "format": "date-time" }, "terminationReason": { "type": [ "string", "null" ] } } } } } ] }, "assignment-termination-cancelled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.termination.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.termination.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "cancelledDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": "string", "format": "date-time" } } } } } ] }, "assignment-termination-rejected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "assignment.termination.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "assignment.termination.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "approvalTypeId", "assignmentId", "rejectedDate" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "assignmentId": { "type": "string", "format": "uuid" }, "rejectedDate": { "type": "string", "format": "date-time" } } } } } ] }, "bid-submitted": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "bid.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bid.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "bidId", "statusId", "dateSubmitted" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "bidId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateSubmitted": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-cancelled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateCancelled": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-disqualified": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-hm-disqualified": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.hm.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.hm.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-interview-cancelled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateCancelled": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "candidate-interview-completed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateCompleted": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "candidate-interview-pending": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-interview-pending-msp-approval": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.pending.msp.approval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.pending.msp.approval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-interview-qualified": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.qualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.qualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateQualified": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-interview-rejected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-interview-requested": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.requested" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.requested" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRequested": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "candidate-interview-required": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.required" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.required" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateRequired": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-interview-scheduled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.interview.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.interview.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "interviewId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "interviewId": { "type": "string", "format": "uuid" }, "dateScheduled": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "candidate-msp-disqualified": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.msp.disqualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.msp.disqualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateDisqualified": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-msp-qualified": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.msp.qualified" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.msp.qualified" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateQualified": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-offer-accepted": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.accepted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.accepted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateAccepted": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-offer-pending": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-offer-rejected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-offer-started": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.started" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.started" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateStarted": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-offer-withdrawn": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.offer.withdrawn" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.offer.withdrawn" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateWithdrawn": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-onboarded": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.onboarded" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.onboarded" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateOnboarded": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-pending-background-checks": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.background.checks" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.background.checks" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-pending-confirmation": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.confirmation" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.confirmation" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-pending-onboarding": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.onboarding" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.onboarding" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-pending-onboarding-processing": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.onboarding.processing" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.onboarding.processing" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-pending-submission": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.pending.submission" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.pending.submission" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-ready-for-offer": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.ready.for.offer" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.ready.for.offer" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateReadyForOffer": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-rejected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "candidate-resume-added": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.resume.added" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.resume.added" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "attachmentId", "dateAdded" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "attachmentId": { "type": "string", "format": "uuid" }, "dateAdded": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-resume-removed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.resume.removed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.resume.removed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId", "attachmentId", "dateRemoved" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "attachmentId": { "type": "string", "format": "uuid" }, "dateRemoved": { "type": "string", "format": "date-time" } } } } } ] }, "candidate-selected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.selected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.selected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateSelected": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "candidate-submitted": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateSubmitted": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "candidate-withdrawn": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "candidate.withdrawn" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "candidate.withdrawn" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "candidateId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "dateWithdrawn": { "type": [ "string", "null" ], "format": "date-time" } } } } } ] }, "invoice-finalinvoice-completed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "invoice.finalinvoice.completed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "invoice.finalinvoice.completed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "invoiceId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "integer", "example": 1000 }, "categoryName": { "type": "string", "example": "US Staff Aug Final Time" }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" }, "invoiceProcessDate": { "type": "string", "format": "date-time" } } } } } ] }, "payment-type": { "type": "string", "enum": [ "staffAugTimesheet", "staffAugExpense", "staffAugMiscFee", "projectServiceTimesheet", "projectServiceMiscFee", "projectServiceMilestone", "projectServiceExpense" ] }, "invoice-retrieved": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "invoice.retrieved" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "invoice.retrieved" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "invoiceId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "integer", "example": 1000 }, "paymentType": { "type": "string", "enum": [ "staffAugTimesheet", "staffAugExpense", "staffAugMiscFee", "projectServiceTimesheet", "projectServiceMiscFee", "projectServiceMilestone", "projectServiceExpense" ] }, "skip": { "type": "integer", "example": 10 }, "pageSize": { "type": "integer", "example": 20 }, "maxItems": { "type": "integer", "example": 500 }, "dateRetrieved": { "type": "string", "format": "date-time" } } } } } ] }, "project-milestone-payment-pending": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.pending" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.pending" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "project-milestone-payment-rejected": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.rejected" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.rejected" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "dateRejected" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "dateRejected": { "type": "string", "format": "date-time" } } } } } ] }, "project-milestone-payment-scheduled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "project.milestone.payment.scheduled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project.milestone.payment.scheduled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "projectId", "milestoneId", "paymentId", "dateScheduled" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "milestoneId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "dateScheduled": { "type": "string", "format": "date-time" } } } } } ] }, "request-cancelled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.cancelled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.cancelled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "cancelledDate": { "type": [ "string" ], "format": "date-time" } } } } } ] }, "request-edited": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.edited" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.edited" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId", "editedDate", "editedFields", "editedClientDefinedFields" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "editedDate": { "type": [ "string" ], "format": "date-time" }, "editedFields": { "type": "array", "description": "List of field names edited on the request.", "items": { "type": "string", "enum": [ "EndDate", "EstimatedCost", "EstimatedExpense", "HoursPerWeek", "Quantity", "ReasonForRequest", "StartDate" ] } }, "editedClientDefinedFields": { "type": "array", "description": "List of client defined field names edited on the request.", "items": { "type": "string" } } } } } } ] }, "request-filled": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.filled" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.filled" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "totalPositionsFilled": { "type": "integer" }, "filledDate": { "type": "string", "format": "date-time" } } } } } ] }, "request-group-edited": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.group.edited" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.group.edited" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestIds", "editedDate", "editedFields" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "editedDate": { "type": [ "string" ], "format": "date-time" }, "editedFields": { "type": "array", "description": "List of field names edited on the request group.", "items": { "type": "string", "enum": [ "AdminCostCenter", "BillToCostCenter", "HiringManager", "PhysicalWorkLocation", "TaxLocation" ] } } } } } } ] }, "request-opened": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.opened" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.opened" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "dateOpened": { "type": "string", "format": "date-time" } } } } } ] }, "request-placedonhold": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.placedonhold" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.placedonhold" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "datePlacedOnHold": { "type": "string", "format": "date-time" } } } } } ] }, "request-releasedtosupplier": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.releasedtosupplier" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.releasedtosupplier" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId", "supplierId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "supplierId": { "type": "string", "format": "uuid" }, "releasedToSupplierDate": { "type": "string", "format": "date-time" } } } } } ] }, "request-reopened": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.reopened" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.reopened" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "approvalTypeId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "dateReOpened": { "type": "string", "format": "date-time" } } } } } ] }, "request-submitted": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "request.submitted" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "request.submitted" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "requestId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "requestId": { "type": "string", "format": "uuid" }, "requestSubmitted": { "type": "string", "format": "date-time" } } } } } ] }, "sow-attachment-added": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.attachment.added" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.attachment.added" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "persona", "attachmentId", "sowSection", "dateAdded" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "persona": { "type": "string", "description": "Identifies whether the detail the attachment was added to was created by the client or vendor. Attachment changes made to details created by the vendor will not be readily available to client access until the statement of work has been submitted back to the client for approval.\n", "enum": [ "client", "vendor" ] }, "attachmentId": { "type": "string", "format": "uuid" }, "sowSection": { "type": "string", "description": "Section of the SOW where the attachment was added.", "enum": [ "sowGeneral", "sowTerms" ] }, "dateAdded": { "type": "string", "format": "date-time" } } } } } ] }, "sow-attachment-removed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.attachment.removed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.attachment.removed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "persona", "attachmentId", "sowSection", "dateRemoved" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "persona": { "type": "string", "description": "Identifies whether the detail the attachment was removed from was created by the client or vendor. Attachment changes made to details created by the vendor will not be readily available to client access until the statement of work has been submitted back to the client for approval.\n", "enum": [ "client", "vendor" ] }, "attachmentId": { "type": "string", "format": "uuid" }, "sowSection": { "type": "string", "description": "Section of the SOW where the attachment was removed.", "enum": [ "sowGeneral", "sowTerms" ] }, "dateRemoved": { "type": "string", "format": "date-time" } } } } } ] }, "sow-pendingclientapproval": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendingclientapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendingclientapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "sow-pendingfinalapproval": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendingfinalapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendingfinalapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "sow-pendinginitialapproval": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.pendinginitialapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.pendinginitialapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "datePending" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "datePending": { "type": "string", "format": "date-time" } } } } } ] }, "sow-readytonegotiate": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.readytonegotiate" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.readytonegotiate" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "dateReady" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateReady": { "type": "string", "format": "date-time" } } } } } ] }, "sow-sourcingcomplete": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "sow.sourcingcomplete" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sow.sourcingcomplete" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "sowId", "statusId", "dateCompleted" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "sowId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "statusId": { "type": "string", "format": "uuid" }, "dateCompleted": { "type": "string", "format": "date-time" } } } } } ] }, "timesheet-submittedforapproval": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "timesheet.submittedforapproval" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "timesheet.submittedforapproval" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "timesheetId", "submitDate", "sourceType" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "timesheetId": { "type": "string", "format": "uuid" }, "submitDate": { "type": "string", "format": "date-time" }, "sourceType": { "type": "string", "enum": [ "Api", "Application", "Import", "Mobile", "WebImport" ] } } } } } ] }, "webhook-ping": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "webhook.ping" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "webhook.ping" ] }, "data": { "type": "object", "required": [ "webhookId" ], "properties": { "webhookId": { "type": "string", "format": "uuid" }, "pingTime": { "type": "string", "format": "date-time" } } } } } ] }, "webhook-validation": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "webhook.validation" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "webhook.validation" ] }, "data": { "type": "object", "properties": { "validationCode": { "type": "string" }, "validationUrl": { "type": "string", "format": "uri" } } } } } ] }, "worker-beelineuniqueid-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.beelineuniqueid.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.beelineuniqueid.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "worker-email-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.email.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.email.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "worker-externalid-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.externalid.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.externalid.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "worker-name-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.name.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.name.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "worker-phonenumber-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.phonenumber.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.phonenumber.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "worker-username-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "worker.username.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "worker.username.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityUserId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityUserId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplier-created": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.created" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.created" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" } } } } } ] }, "supplier-name-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.name.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.name.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplier-externalcode-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.externalcode.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.externalcode.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplier-description-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.description.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.description.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplier-inactivated": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.inactivated" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.inactivated" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "inactivatedDate": { "type": "string", "format": "date-time" } } } } } ] }, "supplier-activated": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.activated" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.activated" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "activatedDate": { "type": "string", "format": "date-time" } } } } } ] }, "supplier-billingname-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.billingname.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.billingname.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplier-emailaddress-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.emailaddress.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.emailaddress.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplier-vettingstatus-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.vettingstatus.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.vettingstatus.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplier-phonenumber-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.phonenumber.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.phonenumber.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplier-mailingaddress-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.mailingaddress.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.mailingaddress.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplier-billingaddress-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplier.billingaddress.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplier.billingaddress.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "securityOrganizationId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "securityOrganizationId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplierlegalentity-created": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplierlegalentity.created" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplierlegalentity.created" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "procurementLegalEntityId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "procurementLegalEntityId": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" } } } } } ] }, "supplierlegalentity-name-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplierlegalentity.name.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplierlegalentity.name.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "procurementLegalEntityId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "procurementLegalEntityId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplierlegalentity-apcode-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplierlegalentity.apcode.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplierlegalentity.apcode.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "procurementLegalEntityId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "procurementLegalEntityId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "supplierlegalentity-blanketponumber-changed": { "allOf": [ { "type": "object", "description": "Webhook Event Data", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event" }, "type": { "type": "string", "description": "The type of event" }, "time": { "type": "string", "format": "date-time", "description": "The time the event was generated and sent. Due to retries, this may be different than when you receive the event." }, "data": { "type": "object", "description": "The event data" } } }, { "title": "supplierlegalentity.blanketponumber.changed" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "supplierlegalentity.blanketponumber.changed" ] }, "data": { "type": "object", "required": [ "clientId", "clientSiteId", "procurementLegalEntityId" ], "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSiteId": { "type": "string", "format": "uuid" }, "procurementLegalEntityId": { "type": "string", "format": "uuid" }, "dateUpdated": { "type": "string", "format": "date-time" } } } } } ] }, "inner-error": { "type": "object", "description": "An object containing more specific information than the current object about the error.", "properties": { "code": { "type": "string", "description": "A more specific error code than was provided by the containing error." }, "innerError": { "type": "object", "description": "The Inner Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } } }, "error-inner": { "type": "object", "description": "The Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." }, "details": { "type": "array", "description": "An array of details about specific errors that led to this reported error.", "items": { "type": "object", "description": "The Specific Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } }, "innerError": { "type": "object", "description": "An object containing more specific information than the current object about the error.", "properties": { "code": { "type": "string", "description": "A more specific error code than was provided by the containing error." }, "innerError": { "type": "object", "description": "The Inner Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } } } } }, "error-response-inner": { "type": "object", "description": "An Error Response.", "required": [ "error" ], "properties": { "error": { "type": "object", "description": "The Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." }, "details": { "type": "array", "description": "An array of details about specific errors that led to this reported error.", "items": { "type": "object", "description": "The Specific Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } }, "innerError": { "type": "object", "description": "An object containing more specific information than the current object about the error.", "properties": { "code": { "type": "string", "description": "A more specific error code than was provided by the containing error." }, "innerError": { "type": "object", "description": "The Inner Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } } } } } } } }, "securitySchemes": { "client_auth": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://integrations.auth.beeline.com/oauth/token", "scopes": { "read:webhook_management": "Read Webhook Management", "write:webhook_management": "Write Webhook Management" } } } } }, "examples": { "rate-limit-error-response": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } }