Skip to main content
Deel
Previewv2.1.0
92 actions · 55 events · 2 auth methods
HRISATS

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Token

Uses a bearer token generated from the Deel Developer Center. Organization tokens grant full org access; personal tokens…

Connector Profile · OAuth 2.0

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.

Webhooks setup

3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Token

Link Account · OAuth 2.0

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
92 actions
Action
Description
Required scopes
List Adjustment Categories
Retrieve adjustment categories for your organization
List ATS Candidates
Retrieve a paginated list of candidates in the ATS
List ATS Jobs
Retrieve a paginated list of jobs in the ATS
List ATS Applications
Retrieve a paginated list of candidate applications
Get ATS Application
Retrieve a single application by ID
List ATS Job Postings
Retrieve a list of ATS job postings
List ATS Offers
Retrieve a list of ATS offers
Create ATS Candidate
Create a new candidate in the ATS
Create ATS Application
Create a new application linking a candidate to a job
Get ATS Job Posting
Retrieve a specific job posting by ID
List ATS Departments
Retrieve a list of departments in the ATS
List ATS Locations
Retrieve a list of locations in the ATS
Create ATS Job
Create a job in the ATS
List ATS Employment Types
Retrieve the employment types defined in the ATS
Retrieve A List Of ATS Teams
Retrieve the teams defined in the ATS
List Contract Templates
Retrieve contract templates available in the organization
List Contracts
Retrieve a list of contracts
Get Contract
Retrieve a single contract by ID
Create Contract
Create a new contractor contract
List Departments
Retrieve a list of departments in the organization
Get EOR Hiring Guide By Country
Retrieve hiring guide data for a specific country
Calculate EOR Employment Cost
Calculate total employment costs for an EOR arrangement
List EOR Job Scope Templates
Retrieve job scope templates for EOR contracts
List EOR Benefits
Retrieve the benefits available for an EOR hire in a country
List GP Payroll Events By Legal Entity
Retrieve payroll events for a specific legal entity
List GP Worker Payslips
Retrieve payslips for a Global Payroll worker
List Groups
Retrieve a list of groups in the organization
Create Group
Create a new group within the organization
Update Group
Edit the details of an existing group
Delete Group
Archive an existing group
List Organization Structures
Retrieve the organization’s hierarchical structure
Get Organization Structure
Retrieve a specific organization structure by ID
List Worker Relations
Retrieve worker relations for an HRIS profile
List Worker Relation Types
Retrieve all worker relation types defined for the organization
Create Organization Structure
Create a new HRIS organization structure with its teams
Update Organization Structure
Update an existing HRIS organization structure and its teams
Delete Organization Structure
Delete an HRIS organization structure
Create Worker Relation
Link a parent HRIS profile to one or more child profiles under a relation type
Delete Worker Relation
Remove a worker relation
Create Worker Relation Type
Create a worker relation type
Update Worker Relation Type
Update the names or external ID of a worker relation type
Delete Worker Relation Type
Delete a worker relation type
List Invoices
Retrieve a list of invoices for your workforce
Get Invoice
Retrieve invoice details by ID
List Deel Invoices
Retrieve a list of Deel fee invoices
List Legal Entities
Retrieve a list of legal entities in the account
Create Legal Entity
Create a legal entity in the organization
Update Legal Entity
Update a legal entity
Delete Legal Entity
Archive a legal entity
List Countries
Retrieve the list of countries supported by Deel
List Currencies
Retrieve the list of currencies supported by Deel
List Job Titles
Retrieve pre-defined job titles from the Deel platform
List Seniority Levels
Retrieve predefined seniority levels from Deel
List Time Off Types
Retrieve predefined time-off types from Deel
List Managers
Retrieve a list of all managers in the organization
Create Manager
Create a manager account in the organization
List Offboarding
Retrieve a list of contracts in the offboarding process
List Onboarding Employees
Retrieve workers currently going through onboarding
Get Organization
Retrieve details of the current organization
List Organization Tasks
Retrieve a list of tasks for the organization
List Working Locations
Retrieve available work location labels for the organization
List Payments
Retrieve a list of payment receipts
List People
Retrieve a list of people in the organization
Get Person
Retrieve a single person by their ID
List People Custom Fields
Retrieve all custom fields associated with People records
Create Person
Hire a direct employee into the HRIS
List Roles
Retrieve a list of roles assigned within the organization
Create Role
Create a custom organization role
Update Role
Update a custom organization role
List Time Off Requests
Retrieve a list of time-off requests for the organization
Get Work Schedule And Holidays
Retrieve holidays, work schedules, and time-off dailies for a date range
List Time Off Policies
Retrieve the time-off policies assigned to a person
Create Time Off Request
Create a time-off request for a person
Update Time Off Request
Update an existing time-off request
Cancel Time Off Request
Cancel a time-off request
Review Time Off Requests
Approve or reject one or more pending time-off requests
List Time Tracking Shift Rates
Retrieve a paginated list of shift rates
List Time Tracking Shifts
Retrieve a paginated list of shifts
Create Shift Rate
Create a time-tracking shift rate
Update Shift Rate
Update a shift rate by its external ID
Delete Shift Rate
Delete a shift rate by its external ID
Create Shifts
Record one or more shifts against a contract
Update Shift
Update a shift by its external ID
Delete Shift
Delete a shift by its external ID
List Timesheets
Retrieve a list of timesheets
Create Timesheet
Record a timesheet entry against a contract
Update Timesheet
Update a timesheet entry
Delete Timesheet
Request deletion of a timesheet entry
Review Timesheet
Approve or decline a timesheet entry
List Timesheet Presets
Retrieve the timesheet presets available on a contract
Get Timesheet Preset
Retrieve a single timesheet preset by its ID
List Webhooks
Retrieve a list of webhook subscriptions

Events

|
55 events
Event
Description
Tags
Active Check
Responds with 200 OK to any Deel webhook delivery that does not carry a recognized event type.
Health Checks
ATS Application Created
Fired when a candidate application is created in Deel ATS.
ATS
ATS Application Transitioned
Fired when a candidate application moves between interview stages.
ATS
ATS Job Posting Publication Created
Fired when a job posting begins publication to a specific job board.
ATS
ATS Job Posting Publication Updated
Fired when a job-board publication is updated.
ATS
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
Fired when a job posting is updated.
ATS
Background Check Result Available
Fired when a background-check result becomes available.
Background Checks
Contract Amended
Fired when a contract amendment is applied.
Contracts
Contract Created
Fired when a contractor or EOR contract is created.
Contracts
Contract Duplicated
Fired when a contract is duplicated.
Contracts
Contract Sign Team Member Invited
Fired when a team member is invited into a contract-signing flow.
Contracts
Contract Status Updated
Fired whenever a contract’s status changes.
Contracts
Contract Terminated
Fired when a contract termination is completed, for contractor, EOR, and Global Payroll contracts.
Contracts
Employee Created Contractor
Fired when a contractor’s contract has been signed and the worker record has been created.
People
Employee Created Direct
Fired when a direct employee record is created.
People
Employee Created EOR
Fired when an EOR employee record is created.
People
Employee Updated Direct
Fired when direct employee information is updated.
People
Engage Learning Journeys Assignments Created
Fired when a learning-journey assignment is created.
Learning
Engage Learning Journeys Assignments Reminded
Fired when a reminder is sent for a learning-journey assignment.
Learning
EOR Amendment Status Updated
Fired when an EOR amendment’s status changes.
EOR & Global Payroll
EOR Payslips Available
Fired when one or more EOR payslips become available.
EOR & Global Payroll
EOR Project Assignment Check-in 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
Fired when a project assignment for an EOR contract is created and ready for the client to review.
EOR & Global Payroll
EOR Quote Created
Fired when an EOR quote is created.
EOR & Global Payroll
GP Payslips Available
Fired when one or more Global Payroll payslips become available.
EOR & Global Payroll
GP Termination Confirmed
Fired when a Global Payroll termination is confirmed.
EOR & Global Payroll
Immigration Case Process Status Updated
Fired when an immigration case process’s status changes.
Immigration
Immigration Case Renewal Created
Fired when an expiring immigration document causes a renewal case to be created automatically.
Immigration
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
Fired when an invoice adjustment requires approval.
Payroll & Payments
Invoice Adjustment Reviewed
Fired when an invoice adjustment is reviewed.
Payroll & Payments
IT Asset Archived
Fired when an IT asset is archived, removing it from active assignment.
IT Assets
IT Asset Created
Fired when an IT asset is created.
IT Assets
IT Asset Location Updated
Fired when an IT asset’s location changes.
IT Assets
IT Order Created
Fired when an IT order is created.
IT Assets
IT Order Updated
Fired when an IT order is updated.
IT Assets
Onboarding Checklist Updated
Fired when an individual onboarding checklist step changes status.
Onboarding
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
Fired when a payment statement is initiated.
Payroll & Payments
Payment Statement Marked Paid
Fired when a payment statement is marked as paid.
Payroll & Payments
Payslip Document Deleted
Fired when a published payslip document is deleted.
Payroll & Payments
Profile KYC Changed
Fired when a profile’s KYC status changes.
People
Tax Document Available
Fired when a tax document is published.
Payroll & Payments
Tax Document Deleted
Fired when a published tax document is deleted.
Payroll & Payments
Time Off Created
Fired when a time-off request is created.
Time Off & Timesheets
Time Off Deleted
Fired when a time-off request is deleted.
Time Off & Timesheets
Time Off Reviewed
Fired when a time-off request is reviewed.
Time Off & Timesheets
Time Off Updated
Fired when a time-off request is updated.
Time Off & Timesheets
Timesheet Created
Fired when a timesheet is created.
Time Off & Timesheets
Timesheet Reviewed
Fired when a timesheet is reviewed.
Time Off & Timesheets
Worker Created (SCIM)
Fired when a worker record is created through SCIM provisioning.
People
Worker Profile Created
Fired when a worker profile is created.
People
Worker Profile Deleted
Fired when a worker profile is deleted.
People
Worker Profile Updated
Fired when a worker profile’s data changes, covering profile, contract, compensation, address, phone, custom fields, or…
People