> ## Documentation Index > Fetch the complete documentation index at: https://developer.remote.com/llms.txt > Use this file to discover all available pages before exploring further. # Invite employment Invite an employment to start the self-enrollment. Requirements for the invitation to succeed: * Employment needs to have the following JSON Schema forms filled: `contract_details` and `pricing_plan_details` * `provisional_start_date` must consider the minimum onboarding time of the employment's country If there are validations errors, they are returned with a Conflict HTTP Status (409) and a descriptive message. HTTP Status OK (200) is returned in case of success. In case of the following error message: `"Please reselect benefits - the previous selection is no longer available"` it means that the benefit options have been updated and the employment's benefits are no longer compliant with the new schema. In this case, reselect benefits by updating `contract_details` JSON Schema form. ## Scopes | Category | Read only Scope | Write only Scope (read access implicit) | |---|---|---| | Manage employments (`employments`) | - | Manage employments (`employment:write`) | # OpenAPI definition ```json { "components": { "schemas": { "ActionError": { "properties": { "action": { "description": "The action that lead to the error message.", "type": "string" }, "code": { "description": "An error code that describes the nature of the error.", "type": "string" }, "message": { "description": "A developer friendly error message that gives details on what the error was and how it may be remedied.", "type": "string" } }, "required": [ "code", "message", "action" ], "title": "ActionError", "type": "object" }, "UnprocessableEntityResponse": { "anyOf": [ { "properties": { "errors": { "type": "object" } }, "required": [ "errors" ], "type": "object" }, { "properties": { "message": { "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/ParameterError" }, { "items": { "$ref": "#/components/schemas/ParameterError" }, "title": "ParameterErrors", "type": "array" }, { "$ref": "#/components/schemas/ActionError" }, { "items": { "$ref": "#/components/schemas/ActionError" }, "title": "ActionErrors", "type": "array" } ] } }, "required": [ "message" ], "type": "object" } ], "example": { "errors": { "some_field": [ "is invalid" ] } }, "title": "UnprocessableEntityResponse", "type": "object" }, "SuccessResponse": { "description": "A generic success response returned by operations that don't produce a specific resource (e.g., updates, deletes).", "example": { "data": { "status": "ok" } }, "properties": { "data": { "properties": { "status": { "description": "The result status. Always `\"ok\"` for successful operations.", "type": "string" } }, "type": "object" } }, "required": [ "data" ], "title": "SuccessResponse", "type": "object" }, "TooManyRequestsResponse": { "description": "Returned when the API rate limit has been exceeded (HTTP 429). Wait before retrying. Check the `Retry-After` response header for the recommended wait time.", "example": { "message": "Too many requests" }, "properties": { "message": { "pattern": "Too many requests", "type": "string" } }, "title": "TooManyRequestsResponse", "type": "object" }, "ConflictResponse": { "description": "Returned when the request conflicts with the current state of a resource (HTTP 409). For example, trying to create a resource that already exists or performing an action that requires the resource to be in a different state.", "example": { "message": "Company needs to be in status active to manage employments" }, "properties": { "message": { "description": "A human-readable message describing the conflict and the expected state.", "type": "string" } }, "title": "ConflictResponse", "type": "object" }, "BadRequestResponse": { "description": "Returned when the request is malformed or contains invalid parameters. The message may be a simple string or a structured object with a code and detailed message.", "example": { "message": "invalid {resource}" }, "oneOf": [ { "properties": { "message": { "description": "A human-readable error message describing what was wrong with the request.", "type": "string" } }, "required": [ "message" ], "type": "object" }, { "properties": { "message": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "type": "object" } ], "title": "BadRequestResponse", "type": "object" }, "ParameterError": { "example": { "code": "invalid_param", "message": "Invalid parameter", "param": "employment_id" }, "properties": { "code": { "description": "An error code that describes the nature of the error.", "type": "string" }, "message": { "description": "A developer friendly error message that gives details on what the error was and how it may be remedied.", "type": "string" }, "param": { "description": "The parameter that lead to the error message.", "type": "string" } }, "required": [ "code", "message", "param" ], "title": "ParameterError", "type": "object" } }, "securitySchemes": { "CustomerAPIToken": { "description": "Authenticate using API Key generated by the customer in their Integration Settings page.\n", "scheme": "bearer", "type": "http" }, "OAuth2": { "description": "Authenticate using OAuth 2.0 protocol.\n", "flows": { "authorizationCode": { "authorizationUrl": "/auth/oauth2/authorize", "scopes": { "company_department:read": "company_department:read", "webhook:write": "webhook:write", "magic_link:write": "magic_link:write", "offboarding:write": "offboarding:write", "custom_field:write": "custom_field:write", "address:write": "address:write", "expense:read": "expense:read", "employment:write": "employment:write", "identity_verification:write": "identity_verification:write", "timesheet:write": "timesheet:write", "travel_letter:write": "travel_letter:write", "incentive:read": "incentive:read", "personal_detail:read": "personal_detail:read", "invoices:write": "invoices:write", "work_authorization:write": "work_authorization:write", "timeoff:write": "timeoff:write", "company_structure:read": "company_structure:read", "benefit_renewal:write": "benefit_renewal:write", "benefit_offer:read": "benefit_offer:read", "employment_documents": "employment_documents", "onboarding:write": "onboarding:write", "payroll_run:read": "payroll_run:read", "risk_reserve:write": "risk_reserve:write", "invoices": "invoices", "resignation_letter:read": "resignation_letter:read", "resignation:read": "resignation:read", "convert_currency:read": "convert_currency:read", "employments": "employments", "probation_document:read": "probation_document:read", "company_admin": "company_admin", "payroll": "payroll", "help_center_article:read": "help_center_article:read", "timesheet:read": "timesheet:read", "custom_field_value:write": "custom_field_value:write", "company_currencies:read": "company_currencies:read", "payslip:read": "payslip:read", "pay_item:write": "pay_item:write", "resignation:write": "resignation:write", "custom_field:read": "custom_field:read", "payroll_calendar:read": "payroll_calendar:read", "contract_amendment:write": "contract_amendment:write", "offboarding:read": "offboarding:read", "timeoff:read": "timeoff:read", "probation_document:write": "probation_document:write", "country:read": "country:read", "webhook:read": "webhook:read", "company_department:write": "company_department:write", "company_manager:read": "company_manager:read", "pay_item:read": "pay_item:read", "contract_amendment:read": "contract_amendment:read", "company:read": "company:read", "sso_configuration:write": "sso_configuration:write", "benefit_offer:write": "benefit_offer:write", "contract_eligibility:write": "contract_eligibility:write", "benefit_renewal:read": "benefit_renewal:read", "background_check:read": "background_check:read", "custom_field_value:read": "custom_field_value:read", "expense:write": "expense:write", "identity_verification:read": "identity_verification:read", "address:read": "address:read", "document:write": "document:write", "time_and_attendance": "time_and_attendance", "employment_payments": "employment_payments", "form:read": "form:read", "work_authorization:read": "work_authorization:read", "invoices:read": "invoices:read", "incentive:write": "incentive:write", "employment:read": "employment:read", "contract:read": "contract:read", "company_manager:write": "company_manager:write", "travel_letter:read": "travel_letter:read", "document:read": "document:read", "sso_configuration:read": "sso_configuration:read" }, "tokenUrl": "/auth/oauth2/token" }, "clientCredentials": { "scopes": { "company:read": "company:read", "company:write": "company:write", "company_admin": "company_admin", "company_management": "company_management", "convert_currency:read": "convert_currency:read", "country:read": "country:read", "employment_documents": "employment_documents", "employment_payments": "employment_payments", "employments": "employments", "help_center_article:read": "help_center_article:read", "invoices": "invoices", "payroll": "payroll", "payroll_calendar:read": "payroll_calendar:read", "pricing_plan:read": "pricing_plan:read", "pricing_plan:write": "pricing_plan:write", "time_and_attendance": "time_and_attendance", "webhook:read": "webhook:read", "webhook:write": "webhook:write" }, "tokenUrl": "/auth/oauth2/token" } }, "type": "oauth2" }, "OAuth2AuthorizationCode": { "description": "Authenticate as the token authorizer using `authorization_code` / `refresh_token` grants in the OAuth 2.0 protocol.\n", "flows": { "authorizationCode": { "authorizationUrl": "/auth/oauth2/authorize", "refreshUrl": "/auth/oauth2/token", "scopes": { "company_department:read": "company_department:read", "webhook:write": "webhook:write", "magic_link:write": "magic_link:write", "offboarding:write": "offboarding:write", "custom_field:write": "custom_field:write", "address:write": "address:write", "expense:read": "expense:read", "employment:write": "employment:write", "identity_verification:write": "identity_verification:write", "timesheet:write": "timesheet:write", "travel_letter:write": "travel_letter:write", "incentive:read": "incentive:read", "personal_detail:read": "personal_detail:read", "invoices:write": "invoices:write", "work_authorization:write": "work_authorization:write", "timeoff:write": "timeoff:write", "company_structure:read": "company_structure:read", "benefit_renewal:write": "benefit_renewal:write", "benefit_offer:read": "benefit_offer:read", "employment_documents": "employment_documents", "onboarding:write": "onboarding:write", "payroll_run:read": "payroll_run:read", "risk_reserve:write": "risk_reserve:write", "invoices": "invoices", "resignation_letter:read": "resignation_letter:read", "resignation:read": "resignation:read", "convert_currency:read": "convert_currency:read", "employments": "employments", "probation_document:read": "probation_document:read", "company_admin": "company_admin", "payroll": "payroll", "help_center_article:read": "help_center_article:read", "timesheet:read": "timesheet:read", "custom_field_value:write": "custom_field_value:write", "company_currencies:read": "company_currencies:read", "payslip:read": "payslip:read", "pay_item:write": "pay_item:write", "resignation:write": "resignation:write", "custom_field:read": "custom_field:read", "payroll_calendar:read": "payroll_calendar:read", "contract_amendment:write": "contract_amendment:write", "offboarding:read": "offboarding:read", "timeoff:read": "timeoff:read", "probation_document:write": "probation_document:write", "country:read": "country:read", "webhook:read": "webhook:read", "company_department:write": "company_department:write", "company_manager:read": "company_manager:read", "pay_item:read": "pay_item:read", "contract_amendment:read": "contract_amendment:read", "company:read": "company:read", "sso_configuration:write": "sso_configuration:write", "benefit_offer:write": "benefit_offer:write", "contract_eligibility:write": "contract_eligibility:write", "benefit_renewal:read": "benefit_renewal:read", "background_check:read": "background_check:read", "custom_field_value:read": "custom_field_value:read", "expense:write": "expense:write", "identity_verification:read": "identity_verification:read", "address:read": "address:read", "document:write": "document:write", "time_and_attendance": "time_and_attendance", "employment_payments": "employment_payments", "form:read": "form:read", "work_authorization:read": "work_authorization:read", "invoices:read": "invoices:read", "incentive:write": "incentive:write", "employment:read": "employment:read", "contract:read": "contract:read", "company_manager:write": "company_manager:write", "travel_letter:read": "travel_letter:read", "document:read": "document:read", "sso_configuration:read": "sso_configuration:read" }, "tokenUrl": "/auth/oauth2/token" } }, "type": "oauth2" } } }, "info": { "title": "Employments", "version": "1.0.0" }, "openapi": "3.1.0", "paths": { "/v1/employments/{employment_id}/invite": { "post": { "callbacks": {}, "deprecated": false, "description": "Invite an employment to start the self-enrollment.\n\nRequirements for the invitation to succeed:\n\n* Employment needs to have the following JSON Schema forms filled: `contract_details` and `pricing_plan_details`\n* `provisional_start_date` must consider the minimum onboarding time of the employment's country\n\nIf there are validations errors, they are returned with a Conflict HTTP Status (409) and a descriptive message.\nHTTP Status OK (200) is returned in case of success.\n\nIn case of the following error message:\n`\"Please reselect benefits - the previous selection is no longer available\"`\nit means that the benefit options have been updated and the employment's benefits are no longer compliant with the new schema.\n\nIn this case, reselect benefits by updating `contract_details` JSON Schema form.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n", "operationId": "post_v1_employments_employment_id_invite", "parameters": [ { "description": "Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.\n\nThe refresh token needs to have been obtained through the Authorization Code flow.\n", "example": "Bearer ", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" } }, { "description": "Employment ID", "example": "31b8e49b-aa1c-47af-849c-3d0a53e20e0d", "in": "path", "name": "employment_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } }, "description": "Unprocessable Entity" } }, "security": [ { "CustomerAPIToken": [ "https://gateway.remote.com/company.manage", "employment:write", "employments", "all:write" ], "OAuth2AuthorizationCode": [ "https://gateway.remote.com/company.manage", "employment:write", "employments", "all:write" ] } ], "summary": "Invite employment", "tags": [ "Employment Management" ] } } }, "security": [ { "OAuth2": [] } ], "servers": [ { "url": "https://gateway.remote.com/", "variables": {} }, { "url": "https://gateway.remote-sandbox.com/", "variables": {} } ], "tags": [ { "name": "Employments" } ], "webhooks": { "background_check.status.updated": { "post": { "deprecated": false, "description": "This event is triggered when a background check request status is updated.", "operationId": "background_check.status.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "background_check_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "company_id": "ba310525-9282-40c9-8977-14d844bf891a", "employment_id": "e966a8b8-1076-11ee-a5f2-9b3997a968f6", "event_type": "background_check.status.updated" }, "properties": { "background_check_id": { "description": "The unique identifier of the background check.", "type": "string" }, "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "background_check_id", "company_id", "employment_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "background_check.status.updated", "tags": [ "Background Checks" ] } }, "employment.account.updated": { "post": { "deprecated": false, "description": "This event is triggered whenever an employment account email is updated.", "operationId": "employment.account.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.account.updated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.account.updated", "tags": [ "Employment Management" ] } }, "employment.administrative_details.updated": { "post": { "deprecated": false, "description": "This event is triggered when the administrative details of an employment are updated.", "operationId": "employment.administrative_details.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_slug": "f2a1b3c4-d5e6-7f8g-9h0i-j1k2l3m4n5o6", "event_type": "employment.administrative_details.updated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_slug": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_slug", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.administrative_details.updated", "tags": [ "Employment Management" ] } }, "employment.details.updated": { "post": { "deprecated": false, "description": "This event is triggered whenever an employment `department` or `manager` is updated.", "operationId": "employment.details.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.details.updated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.details.updated", "tags": [ "Employment Management" ] } }, "employment.employment_agreement.available": { "post": { "deprecated": false, "description": "This event is triggered when an employment agreement is available for a user", "operationId": "employment.employment_agreement.available", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.employment_agreement.available", "file_id": "0073fcb5-b669-4e4a-b963-2a47744e75a1" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" }, "file_id": { "description": "The unique identifier of the related file.", "type": "string" } }, "required": [ "file_id", "employment_id", "event_type", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.employment_agreement.available", "tags": [ "Employments" ] } }, "employment.eor_hiring.invoice_created": { "post": { "deprecated": false, "description": "This event is triggered when a invoice report is created for a employment.", "operationId": "employment.eor_hiring.invoice_created", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "f2a1b3c4-d5e6-7f8g-9h0i-j1k2l3m4n5o6", "employment_id": "f8e9d2c7-3a1b-4f5c-9e6d-8b7a2c1d0e3f", "event_type": "employment.eor_hiring.invoice_created", "invoice_report_id": "c7f8e9d2-3a1b-4f5c-9e6d-8b7a2c1d0e3f" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" }, "invoice_report_id": { "description": "The unique identifier of the invoice report.", "type": "string" } }, "required": [ "event_type", "employment_id", "invoice_report_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.eor_hiring.invoice_created", "tags": [ "Employments" ] } }, "employment.eor_hiring.proof_of_payment_accepted": { "post": { "deprecated": false, "description": "This event is triggered when a proof of payment is accepted.", "operationId": "employment.eor_hiring.proof_of_payment_accepted", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "f2a1b3c4-d5e6-7f8g-9h0i-j1k2l3m4n5o6", "employment_id": "f8e9d2c7-3a1b-4f5c-9e6d-8b7a2c1d0e3f", "event_type": "employment.eor_hiring.proof_of_payment_accepted", "proof_of_payment_id": "c7f8e9d2-3a1b-4f5c-9e6d-8b7a2c1d0e3f" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" }, "proof_of_payment_id": { "description": "The unique identifier of the proof of payment.", "type": "string" } }, "required": [ "event_type", "employment_id", "proof_of_payment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.eor_hiring.proof_of_payment_accepted", "tags": [ "Employments" ] } }, "employment.eor_hiring.proof_of_payment_submitted": { "post": { "deprecated": false, "description": "This event is triggered when a proof of payment is submitted (uploaded) for an EOR hiring onboarding.", "operationId": "employment.eor_hiring.proof_of_payment_submitted", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "f2a1b3c4-d5e6-7f8g-9h0i-j1k2l3m4n5o6", "employment_id": "f8e9d2c7-3a1b-4f5c-9e6d-8b7a2c1d0e3f", "event_type": "employment.eor_hiring.proof_of_payment_submitted", "proof_of_payment_id": "c7f8e9d2-3a1b-4f5c-9e6d-8b7a2c1d0e3f" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" }, "proof_of_payment_id": { "description": "The unique identifier of the proof of payment.", "type": "string" } }, "required": [ "event_type", "employment_id", "proof_of_payment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.eor_hiring.proof_of_payment_submitted", "tags": [ "Employments" ] } }, "employment.no_longer_eligible_for_onboarding_cancellation": { "post": { "deprecated": false, "description": "This event is triggered when an employment is no longer eligible for onboarding cancellation.", "operationId": "employment.no_longer_eligible_for_onboarding_cancellation", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_slug": "ba310525-9282-40c9-8977-14d844bf891a" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_slug": { "description": "The unique identifier of the related employment.", "type": "string" } }, "required": [ "employment_slug", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.no_longer_eligible_for_onboarding_cancellation", "tags": [ "Employments" ] } }, "employment.onboarding.cancelled": { "post": { "deprecated": false, "description": "This event is triggered when an employment onboarding is cancelled.", "operationId": "employment.onboarding.cancelled", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "f8e9d2c7-3a1b-4f5c-9e6d-8b7a2c1d0e3f", "event_type": "employment.onboarding.cancelled" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.onboarding.cancelled", "tags": [ "Employments" ] } }, "employment.onboarding.completed": { "post": { "deprecated": false, "description": "This event is triggered when an employment onboarding is completed and the\nemployment is set to `active`.\n\nAn onboarding is considered complete when the employee finishes their self-enrollment\nand has completed all the onboarding tasks assigned to them (Personal profile, Administrative details,\nEmergency contact, Supporting documentation, etc).\n", "operationId": "employment.onboarding.completed", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.onboarding.completed" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.onboarding.completed", "tags": [ "Employment Management" ] } }, "employment.onboarding.started": { "post": { "deprecated": false, "description": "This event is triggered when an employment onboarding is started.\n", "operationId": "employment.onboarding.started", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.onboarding.started" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.onboarding.started", "tags": [ "Employment Management" ] } }, "employment.onboarding_task.completed": { "post": { "deprecated": false, "description": "This event is triggered everytime an employment onboarding task\n(Personal profile, Administrative details, Emergency contact,\nSupporting documentation, etc) is completed by an employee during\nthe self-enrollment.\n", "operationId": "employment.onboarding_task.completed", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "97c7ce7e-ca67-11ed-bce5-3bb70cbb9f9e", "completed_task": { "action": "administrative_details", "completed_at": "2023-03-23T03:21:23Z", "description": "description for administrative details", "name": "Administrative details", "required": true, "status": "completed" }, "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.onboarding_task.completed" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "completed_task": { "properties": { "action": { "description": "The action identifier for this task.", "enum": [ "additional_documents", "administrative_details", "business_information", "emergency_contact", "home_address", "i9_verification", "identity_verification", "payment_details", "review_compensation", "safetywing_enrollment", "user_details", "employment_eligibility" ], "type": "string" }, "completed_at": { "description": "The timestamp when the task was completed.", "format": "datetime", "type": "string" }, "description": { "description": "A description of what this onboarding task covers.", "type": "string" }, "name": { "description": "The name of the completed onboarding task (e.g., \"Personal details\").", "type": "string" }, "required": { "description": "Whether this task was required for onboarding completion.", "type": "boolean" }, "status": { "description": "The status of the task.", "enum": [ "created", "completed" ], "type": "string" } }, "required": [ "name", "description", "required", "completed_at", "action", "status" ] }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "company_id", "employment_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.onboarding_task.completed", "tags": [ "Employment Management" ] } }, "employment.personal_information.updated": { "post": { "deprecated": false, "description": "This event is triggered whenever an employment personal details is updated. Personal details includes personal informations, home address and emergency contact.", "operationId": "employment.personal_information.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.personal_information.updated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.personal_information.updated", "tags": [ "Employment Management" ] } }, "employment.start_date.changed": { "post": { "deprecated": false, "description": "This event is triggered when the start date of an employment is changed", "operationId": "employment.start_date.changed", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.start_date.changed" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "employment_id", "event_type", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.start_date.changed", "tags": [ "Employment Management" ] } }, "employment.status.updated": { "post": { "deprecated": false, "description": "This event is triggered when the employment status is updated", "operationId": "employment.status.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.status.updated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "employment_id", "event_type", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.status.updated", "tags": [ "Employment Management" ] } }, "employment.updated": { "post": { "deprecated": false, "description": "This event is triggered when an employment is updated.\n", "operationId": "employment.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.updated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.updated", "tags": [ "Employment Management" ] } }, "employment.user_status.activated": { "post": { "deprecated": false, "description": "This event is triggered whenever an employment user is updated to the active status.", "operationId": "employment.user_status.activated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.user_status.activated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.user_status.activated", "tags": [ "Employment Management" ] } }, "employment.user_status.deactivated": { "post": { "deprecated": false, "description": "This event is triggered whenever an employment user is updated to the inactive status.", "operationId": "employment.user_status.deactivated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.user_status.deactivated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.user_status.deactivated", "tags": [ "Employment Management" ] } }, "employment.user_status.initiated": { "post": { "deprecated": false, "description": "This event is triggered whenever an employment user is updated to the initiated status.", "operationId": "employment.user_status.initiated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.user_status.initiated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.user_status.initiated", "tags": [ "Employment Management" ] } }, "employment.user_status.invited": { "post": { "deprecated": false, "description": "This event is triggered when an employment user status is updated to invited.", "operationId": "employment.user_status.invited", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.user_status.invited" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "employment_id", "event_type", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.user_status.invited", "tags": [ "Employment Management" ] } }, "employment.work_email.updated": { "post": { "deprecated": false, "description": "This event is triggered when an employment work email is updated.\n", "operationId": "employment.work_email.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.work_email.updated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.work_email.updated", "tags": [ "Employment Management" ] } }, "employment_basic_information.updated": { "post": { "deprecated": false, "description": "This event is triggered when the basic information for an employment is updated", "operationId": "employment_basic_information.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment_basic_information.updated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "employment_id", "event_type", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment_basic_information.updated", "tags": [ "Employments" ] } }, "identity_verification.verification_required": { "post": { "deprecated": false, "description": "This event is triggered whenever an identity verification is required for an employment.", "operationId": "identity_verification.verification_required", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "identity_verification.verification_required" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "identity_verification.verification_required", "tags": [ "Identity Verification" ] } } } } ```