> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Deel

> How to set up the Deel connector, plus the actions and events that are available.

![Deel](https://stackone-logos.com/api/deel/filled/svg)

Previewv3.0.0[See changelog](https://docs.stackone.com/connectors/deel/changelog.md)

[92 actions](#actions) · [55 events](#events) · 2 auth methods

HRIS
ATS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Token · Connector Profile](https://docs.stackone.com/connectors/deel/guides/connector-profile/api-token.md)
>
> Uses a bearer token generated from the Deel Developer Center. Organization tokens grant full org access; personal tokens...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/deel/guides/connector-profile/oauth-2-0.md)
>
> Requires creating an OAuth app in the Deel Developer Center. Access tokens expire after 30 days, refresh tokens after 90...

Optionally, configure receiving Events for Deel into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/deel/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Token · Link Account](https://docs.stackone.com/connectors/deel/guides/link-account/api-token.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/deel/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

accounting:read

adjustments:read

ats:read

ats:write

benefits:read

candidates:read

candidates:write

contracts:read

contracts:write

global-payroll:read

groups:read

groups:write

legal-entity:read

legal-entity:write

organizations:read

organizations:write

payslips:read

people:read

people:write

profile:read

profile:write

tasks:read

time-off:read

time-off:write

time-tracking:read

time-tracking:write

timesheets:read

timesheets:write

webhooks:read

No scopes found

92 actions

ActionDescriptionRequired scopes

List Adjustment Categories`deel_get_adjustment_categories`

Retrieve adjustment categories for your organization

`adjustments:read`

List ATS Candidates`deel_retrieve_paginated_list_of_ats_candidates`

Retrieve a paginated list of candidates in the ATS

`ats:read`

List ATS Jobs`deel_retrieve_a_list_of_ats_jobs`

Retrieve a paginated list of jobs in the ATS

`ats:read`

List ATS Applications`deel_retrieve_a_list_of_ats_applications`

Retrieve a paginated list of candidate applications

`ats:read`

Get ATS Application`deel_retrieve_ats_application`

Retrieve a single application by ID

`ats:read`

List ATS Job Postings`deel_retrieve_ats_job_postings`

Retrieve a list of ATS job postings

`ats:read`

List ATS Offers`deel_retrieve_a_list_of_ats_offers`

Retrieve a list of ATS offers

`ats:read`

Create ATS Candidate`deel_create_ats_candidate`

Create a new candidate in the ATS

`ats:write`

Create ATS Application`deel_create_ats_application`

Create a new application linking a candidate to a job

`ats:write`

Get ATS Job Posting`deel_retrieve_ats_job_posting`

Retrieve a specific job posting by ID

`ats:read`

List ATS Departments`deel_retrieve_a_list_of_ats_departments`

Retrieve a list of departments in the ATS

`ats:read`

List ATS Locations`deel_retrieve_a_list_of_ats_locations`

Retrieve a list of locations in the ATS

`ats:read`

Create ATS Job`deel_create_ats_job`

Create a job in the ATS

`ats:write`

List ATS Employment Types`deel_retrieve_a_list_of_ats_employment_types`

Retrieve the employment types defined in the ATS

`ats:read`

Retrieve A List Of ATS Teams`deel_retrieve_a_list_of_ats_teams`

Retrieve the teams defined in the ATS

`ats:read`

List Contract Templates`deel_get_contract_templates`

Retrieve contract templates available in the organization

`contracts:read`

List Contracts`deel_get_contracts`

Retrieve a list of contracts

`contracts:read`

Get Contract`deel_get_contract`

Retrieve a single contract by ID

`contracts:read`

Create Contract`deel_create_ic_contract`

Create a new contractor contract

`contracts:write`

List Departments`deel_get_departments`

Retrieve a list of departments in the organization

`organizations:read`

Get EOR Hiring Guide By Country`deel_get_eor_hiring_guide_by_country`

Retrieve hiring guide data for a specific country

`contracts:read`

Calculate EOR Employment Cost`deel_get_employment_cost`

Calculate total employment costs for an EOR arrangement

`contracts:read`

List EOR Job Scope Templates`deel_get_job_scopes`

Retrieve job scope templates for EOR contracts

`organizations:read`

List EOR Benefits`deel_get_benefits`

Retrieve the benefits available for an EOR hire in a country

`benefits:read`

List GP Payroll Events By Legal Entity`deel_get_gp_legal_entity_reports`

Retrieve payroll events for a specific legal entity

`global-payroll:read`

List GP Worker Payslips`deel_get_gp_worker_payslips`

Retrieve payslips for a Global Payroll worker

`payslips:read`

List Groups`deel_get_groups`

Retrieve a list of groups in the organization

`groups:read`

Create Group`deel_create_group`

Create a new group within the organization

`groups:read``groups:write`

Update Group`deel_update_group`

Edit the details of an existing group

`groups:read``groups:write`

Delete Group`deel_delete_group`

Archive an existing group

`groups:write`

List Organization Structures`deel_get_organization_structures`

Retrieve the organization's hierarchical structure

`organizations:read`

Get Organization Structure`deel_get_organization_structure`

Retrieve a specific organization structure by ID

`organizations:read`

List Worker Relations`deel_get_worker_relation_profile`

Retrieve worker relations for an HRIS profile

`profile:read`

List Worker Relation Types`deel_get_worker_relation_types`

Retrieve all worker relation types defined for the organization

`organizations:read`

Create Organization Structure`deel_create_organization_structure`

Create a new HRIS organization structure with its teams

`organizations:write`

Update Organization Structure`deel_update_organization_structure`

Update an existing HRIS organization structure and its teams

`organizations:write`

Delete Organization Structure`deel_delete_organization_structure`

Delete an HRIS organization structure

`organizations:write`

Create Worker Relation`deel_create_worker_relation_profile`

Link a parent HRIS profile to one or more child profiles under a relation type

`profile:write`

Delete Worker Relation`deel_delete_worker_relation_profile`

Remove a worker relation

`profile:write`

Create Worker Relation Type`deel_create_worker_relation_type`

Create a worker relation type

`organizations:write`

Update Worker Relation Type`deel_update_worker_relation_type`

Update the names or external ID of a worker relation type

`organizations:write`

Delete Worker Relation Type`deel_delete_worker_relation_type`

Delete a worker relation type

`organizations:write`

List Invoices`deel_retrieve_invoices`

Retrieve a list of invoices for your workforce

`accounting:read`

Get Invoice`deel_get_invoice_by_id`

Retrieve invoice details by ID

`accounting:read`

List Deel Invoices`deel_retrieve_deel_invoices`

Retrieve a list of Deel fee invoices

`accounting:read`

List Legal Entities`deel_get_legal_entities`

Retrieve a list of legal entities in the account

`organizations:read``accounting:read`

Create Legal Entity`deel_create_legal_entity`

Create a legal entity in the organization

`legal-entity:write``legal-entity:read`

Update Legal Entity`deel_update_legal_entity`

Update a legal entity

`legal-entity:write`

Delete Legal Entity`deel_delete_legal_entity`

Archive a legal entity

`legal-entity:write``legal-entity:read``candidates:read``candidates:write`

List Countries`deel_get_countries`

Retrieve the list of countries supported by Deel

List Currencies`deel_get_currencies`

Retrieve the list of currencies supported by Deel

List Job Titles`deel_get_job_titles`

Retrieve pre-defined job titles from the Deel platform

List Seniority Levels`deel_get_seniority_levels`

Retrieve predefined seniority levels from Deel

List Time Off Types`deel_get_time_off_types`

Retrieve predefined time-off types from Deel

List Managers`deel_get_managers`

Retrieve a list of all managers in the organization

`organizations:read`

Create Manager`deel_create_manager`

Create a manager account in the organization

`organizations:write`

List Offboarding`deel_retrieve_offboarding_list`

Retrieve a list of contracts in the offboarding process

`contracts:read``people:read`

List Onboarding Employees`deel_list_onboarding_employees`

Retrieve workers currently going through onboarding

`contracts:read``people:read`

Get Organization`deel_get_organizations`

Retrieve details of the current organization

`organizations:read`

List Organization Tasks`deel_list_organization_tasks`

Retrieve a list of tasks for the organization

`tasks:read`

List Working Locations`deel_retrieve_working_locations`

Retrieve available work location labels for the organization

`organizations:read`

List Payments`deel_retrieve_payment_receipts`

Retrieve a list of payment receipts

`accounting:read`

List People`deel_get_people`

Retrieve a list of people in the organization

`people:read`

Get Person`deel_get_person_by_id`

Retrieve a single person by their ID

`people:read`

List People Custom Fields`deel_get_custom_fields`

Retrieve all custom fields associated with People records

`people:read`

Create Person`deel_create_a_direct_employee`

Hire a direct employee into the HRIS

`people:write`

List Roles`deel_get_the_roles_of_the_current_organization`

Retrieve a list of roles assigned within the organization

`organizations:read`

Create Role`deel_create_organization_role`

Create a custom organization role

`organizations:write`

Update Role`deel_update_organization_role`

Update a custom organization role

`organizations:write`

List Time Off Requests`deel_list_time_off_requests_for_organization`

Retrieve a list of time-off requests for the organization

`time-off:read`

Get Work Schedule And Holidays`deel_get_time_off_dailies`

Retrieve holidays, work schedules, and time-off dailies for a date range

`time-off:read`

List Time Off Policies`deel_get_time_off_policies`

Retrieve the time-off policies assigned to a person

`time-off:read`

Create Time Off Request`deel_create_time_off_request`

Create a time-off request for a person

`time-off:write`

Update Time Off Request`deel_update_time_off_request`

Update an existing time-off request

`time-off:write`

Cancel Time Off Request`deel_delete_time_off_request`

Cancel a time-off request

`time-off:write`

Review Time Off Requests`deel_review_time_off_request`

Approve or reject one or more pending time-off requests

`time-off:write`

List Time Tracking Shift Rates`deel_get_time_tracking_shift_rates`

Retrieve a paginated list of shift rates

`time-tracking:read`

List Time Tracking Shifts`deel_get_time_tracking_shifts`

Retrieve a paginated list of shifts

`time-tracking:read`

Create Shift Rate`deel_create_time_tracking_shift_rate`

Create a time-tracking shift rate

`time-tracking:write`

Update Shift Rate`deel_update_time_tracking_shift_rate_by_external_id`

Update a shift rate by its external ID

`time-tracking:write`

Delete Shift Rate`deel_delete_time_tracking_shift_rate_by_external_id`

Delete a shift rate by its external ID

`time-tracking:write`

Create Shifts`deel_create_time_tracking_shifts`

Record one or more shifts against a contract

`time-tracking:write`

Update Shift`deel_update_time_tracking_shift_by_external_id`

Update a shift by its external ID

`time-tracking:write`

Delete Shift`deel_delete_time_tracking_shift_by_external_id`

Delete a shift by its external ID

`time-tracking:write`

List Timesheets`deel_get_timesheets`

Retrieve a list of timesheets

`timesheets:read`

Create Timesheet`deel_create_timesheet`

Record a timesheet entry against a contract

`timesheets:write`

Update Timesheet`deel_update_a_timesheet_entry`

Update a timesheet entry

`timesheets:write`

Delete Timesheet`deel_delete_timesheet_by_id`

Request deletion of a timesheet entry

`timesheets:write`

Review Timesheet`deel_create_timesheet_review`

Approve or decline a timesheet entry

`timesheets:write`

List Timesheet Presets`deel_get_contract_timesheets_presets`

Retrieve the timesheet presets available on a contract

`timesheets:read`

Get Timesheet Preset`deel_get_timesheets_preset_by_id`

Retrieve a single timesheet preset by its ID

`timesheets:read`

List Webhooks`deel_get_webhooks`

Retrieve a list of webhook subscriptions

`webhooks:read`

## Events

Tags

Select all
|
Clear

ATS

Background Checks

Contracts

EOR & Global Payroll

Health Checks

IT Assets

Immigration

Learning

Onboarding

Payroll & Payments

People

Time Off & Timesheets

No tags found

55 events

EventDescriptionTags

Active Check`deel_active_check`

Responds with 200 OK to any Deel webhook delivery that does not carry a recognized event type.

Health Checks

ATS Application Created`deel_webhook_ats_application_created`

Fired when a candidate application is created in Deel ATS.

ATS

ATS Application Transitioned`deel_webhook_ats_application_transitioned`

Fired when a candidate application moves between interview stages.

ATS

ATS Job Posting Publication Created`deel_webhook_ats_job_posting_publication_created`

Fired when a job posting begins publication to a specific job board.

ATS

ATS Job Posting Publication Updated`deel_webhook_ats_job_posting_publication_updated`

Fired when a job-board publication is updated.

ATS

ATS Job Posting Created`deel_webhook_ats_job_posting_created`

Fired when a job posting is created in Deel ATS, ahead of any job-board publication.

ATS

ATS Job Posting Updated`deel_webhook_ats_job_posting_updated`

Fired when a job posting is updated.

ATS

Background Check Result Available`deel_webhook_bgcheck_result_available`

Fired when a background-check result becomes available.

Background Checks

Contract Amended`deel_webhook_contract_amended`

Fired when a contract amendment is applied.

Contracts

Contract Created`deel_webhook_contract_created`

Fired when a contractor or EOR contract is created.

Contracts

Contract Duplicated`deel_webhook_contract_duplicated`

Fired when a contract is duplicated.

Contracts

Contract Sign Team Member Invited`deel_webhook_contract_sign_team_member_invited`

Fired when a team member is invited into a contract-signing flow.

Contracts

Contract Status Updated`deel_webhook_contract_status_updated`

Fired whenever a contract's status changes.

Contracts

Contract Terminated`deel_webhook_contract_terminated`

Fired when a contract termination is completed, for contractor, EOR, and Global Payroll contracts.

Contracts

Employee Created Contractor`deel_webhook_employee_created_contractor`

Fired when a contractor's contract has been signed and the worker record has been created.

People

Employee Created Direct`deel_webhook_employee_created_direct`

Fired when a direct employee record is created.

People

Employee Created EOR`deel_webhook_employee_created_eor`

Fired when an EOR employee record is created.

People

Employee Updated Direct`deel_webhook_employee_updated_direct`

Fired when direct employee information is updated.

People

Engage Learning Journeys Assignments Created`deel_webhook_engage_learning_journeys_assignments_created`

Fired when a learning-journey assignment is created.

Learning

Engage Learning Journeys Assignments Reminded`deel_webhook_engage_learning_journeys_assignments_reminded`

Fired when a reminder is sent for a learning-journey assignment.

Learning

EOR Amendment Status Updated`deel_webhook_eor_amendment_status_updated`

Fired when an EOR amendment's status changes.

EOR & Global Payroll

EOR Payslips Available`deel_webhook_eor_payslips_available`

Fired when one or more EOR payslips become available.

EOR & Global Payroll

EOR Project Assignment Check-in Created`deel_webhook_eor_project_assignment_checkin_created`

Fired when a recurring check-in for an EOR project assignment is created and becomes available to complete.

EOR & Global Payroll

EOR Project Assignment Created`deel_webhook_eor_project_assignment_created`

Fired when a project assignment for an EOR contract is created and ready for the client to review.

EOR & Global Payroll

EOR Quote Created`deel_webhook_eor_quote_created`

Fired when an EOR quote is created.

EOR & Global Payroll

GP Payslips Available`deel_webhook_gp_payslips_available`

Fired when one or more Global Payroll payslips become available.

EOR & Global Payroll

GP Termination Confirmed`deel_webhook_gp_termination_confirmed`

Fired when a Global Payroll termination is confirmed.

EOR & Global Payroll

Immigration Case Process Status Updated`deel_webhook_immigration_case_process_status_update`

Fired when an immigration case process's status changes.

Immigration

Immigration Case Renewal Created`deel_webhook_immigration_case_renewal_created`

Fired when an expiring immigration document causes a renewal case to be created automatically.

Immigration

Invoice Adjustment Created`deel_webhook_invoice_adjustment_created`

Fired when an invoice adjustment is created, covering categories such as bonus, commission, deduction, expense, overtime...

Payroll & Payments

Invoice Adjustment Pending For Approval`deel_webhook_invoice_adjustment_pending_for_approval`

Fired when an invoice adjustment requires approval.

Payroll & Payments

Invoice Adjustment Reviewed`deel_webhook_invoice_adjustment_reviewed`

Fired when an invoice adjustment is reviewed.

Payroll & Payments

IT Asset Archived`deel_webhook_it_asset_archived`

Fired when an IT asset is archived, removing it from active assignment.

IT Assets

IT Asset Created`deel_webhook_it_asset_created`

Fired when an IT asset is created.

IT Assets

IT Asset Location Updated`deel_webhook_it_asset_location_updated`

Fired when an IT asset's location changes.

IT Assets

IT Order Created`deel_webhook_it_order_created`

Fired when an IT order is created.

IT Assets

IT Order Updated`deel_webhook_it_order_updated`

Fired when an IT order is updated.

IT Assets

Onboarding Checklist Updated`deel_webhook_onboarding_checklist_updated`

Fired when an individual onboarding checklist step changes status.

Onboarding

Onboarding Status Updated`deel_webhook_onboarding_status_updated`

Fired when a worker's overall onboarding status changes, for example moving from invited, to onboarding, to complete.

Onboarding

Payment Statement Initiated`deel_webhook_payment_statement_initiated`

Fired when a payment statement is initiated.

Payroll & Payments

Payment Statement Marked Paid`deel_webhook_payment_statement_mark_paid`

Fired when a payment statement is marked as paid.

Payroll & Payments

Payslip Document Deleted`deel_webhook_payslip_document_deleted`

Fired when a published payslip document is deleted.

Payroll & Payments

Profile KYC Changed`deel_webhook_profile_kyc_changed`

Fired when a profile's KYC status changes.

People

Tax Document Available`deel_webhook_tax_document_available`

Fired when a tax document is published.

Payroll & Payments

Tax Document Deleted`deel_webhook_tax_document_deleted`

Fired when a published tax document is deleted.

Payroll & Payments

Time Off Created`deel_webhook_time_off_created`

Fired when a time-off request is created.

Time Off & Timesheets

Time Off Deleted`deel_webhook_time_off_deleted`

Fired when a time-off request is deleted.

Time Off & Timesheets

Time Off Reviewed`deel_webhook_time_off_reviewed`

Fired when a time-off request is reviewed.

Time Off & Timesheets

Time Off Updated`deel_webhook_time_off_updated`

Fired when a time-off request is updated.

Time Off & Timesheets

Timesheet Created`deel_webhook_timesheet_created`

Fired when a timesheet is created.

Time Off & Timesheets

Timesheet Reviewed`deel_webhook_timesheet_reviewed`

Fired when a timesheet is reviewed.

Time Off & Timesheets

Worker Created (SCIM)`deel_webhook_worker_created`

Fired when a worker record is created through SCIM provisioning.

People

Worker Profile Created`deel_webhook_worker_v2_created`

Fired when a worker profile is created.

People

Worker Profile Deleted`deel_webhook_worker_v2_deleted`

Fired when a worker profile is deleted.

People

Worker Profile Updated`deel_webhook_worker_v2_updated`

Fired when a worker profile's data changes, covering profile, contract, compensation, address, phone, custom fields, or...

People


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.