Deel setup guide

Agents help with people, candidates and hiring.

Ways to connect

Company admins connect apps, on the Integrations page in Everdeck: open Deel, choose one of the ways below, follow its steps and fill in its fields. Everdeck checks what you enter before it saves anything, and asks you to confirm it’s you (your second factor) before you type any secret. How connecting works.

Deel can be connected 2 ways. Where there’s a key or token to paste, that’s usually the quickest.

Organization API token

API key.

1. In Deel, open More > Developer and go to the Access Tokens tab.
2. Click Generate new token and choose Organization token (access to the whole organization).
3. Select the scopes listed below, set which sensitive data the token may see, and click Generate.
4. Copy the token right away (it is shown once) and paste it here. Sandbox and production use different tokens.

Field	What to enter
Environment (optional)	Choice: Production, Sandbox (separate sandbox token). Starts as https://api.letsdeel.com/rest.
API token	A secret: Everdeck saves it encrypted and never shows it again. Where to find it.

The scopes Everdeck asks for:

• organizations:read
• people:read
• people:write
• contracts:read
• time-off:read
• time-off:write
• worker:write
• timesheets:read
• timesheets:write

Disconnecting deletes the credentials Everdeck saved, but Everdeck can't revoke them: the key, token or password itself keeps working at Deel until you delete or rotate it there.

Your Deel organization app

Your OAuth app.

This way signs in with an OAuth app you create for Deel, as its steps describe: Everdeck never uses an app of its own. Register this redirect URI with your app:

https://everdeck.io/api/oauth/callback

Then save the app’s client ID and secret in Everdeck, on the connect page or under OAuth apps, and sign in.

1. In Deel, open More > Developer and go to the Apps tab. Click Create new app and choose Organization App.
2. Enter a name (for example Everdeck), a description, and the redirect URI https://everdeck.io/api/oauth/callback.
3. Copy the Client ID and Client Secret into the form (the secret is shown once).
4. Click Connect and approve the scopes listed below as a Deel admin.

The scopes Everdeck asks for:

• organizations:read
• people:read
• people:write
• contracts:read
• time-off:read
• time-off:write
• worker:write
• timesheets:read
• timesheets:write

Disconnecting deletes the tokens Everdeck saved. Deel documents no revocation endpoint: remove the app in Deel's settings.

What agents can do

An agent uses an action only when its charter grants it, on the agent’s Tools tab, where you choose whether each one runs by itself (Auto), asks first or never runs. Each action has a risk tier: tier 3 actions, which customers or the public see, ask first unless you choose otherwise, and tier 4 actions (money, deleting things, access) always need a person. How tools and tiers work.

Actions marked Reads outside content return things people outside your company may have written. Agents treat what they read as information, never as instructions, and their riskier actions later in the same session need approval.

• List or find peopleTier 0 · ReadReads outside contentdeel_list_people

  List people in the organization (employees, EOR workers, contractors) with job title, department, country, manager, start date, hiring status and their contracts. Search by name or filter by hiring type or status.

• Read a personTier 0 · ReadReads outside contentdeel_get_person

  Read one person's profile: personal and employment details, department, manager, direct reports, status and contracts. Use the id from list_people.

• List contractsTier 0 · ReadReads outside contentdeel_list_contracts

  List contracts (contractor, EOR, global payroll and direct employee) with title, type, status, worker, team and signature state. Filter by status, type, country or a name search.

• Read a contractTier 0 · ReadReads outside contentdeel_get_contract

  Read one contract in full: status, worker, job title, start and end dates, compensation, notice period, work schedule, scope of work and signatures.

• List time off requestsTier 0 · ReadReads outside contentdeel_list_time_off_requests

  List the organization's time off requests with dates, amount and unit, type and policy, status (REQUESTED, APPROVED, REJECTED, USED, CANCELED), reason and the person's hris_profile_id (recipient_profile). Filter by status, dates or when they changed.

• Check time off balancesTier 0 · ReadReads outside contentdeel_get_time_off_balances

  Show a person's entitlement, used, requested, approved and available time off for each active policy in the current tracking period. policy.id is what create_time_off_request takes.

• Request time off for a personTier 2 · ReversibleReads outside contentdeel_create_time_off_request

  File a time off request on a person's behalf. It is created as REQUESTED (never pre-approved) and, by default, goes through the approval flow configured in Deel. Some policies need a description.

• Approve or reject time offTier 3 · ExternalReads outside contentdeel_review_time_off_requests

  Approve or reject REQUESTED time off requests (one or many). Rejection is final and cannot be undone through the API. The response lists which were reviewed and why others were not.

• List departmentsTier 0 · ReadReads outside contentdeel_list_departments

  List the organization's departments with their ids and parent departments.

• Assign a person to a departmentTier 2 · ReversibleReads outside contentdeel_set_department

  Put a person in a department, optionally from an effective date. By default the department is added to their existing positions; set replace_other_positions to true to move them out of all other departments instead.

• List contractor timesheetsTier 0 · ReadReads outside contentdeel_list_timesheets

  List timesheets submitted on time-based contractor contracts with hours, amount, currency, status (pending, approved, declined, not_payable, paid, processing), contract and who reported them. Filter by contract, status or submission date.

• Approve or reject a timesheetTier 4 · Money or irreversibleReads outside contentdeel_review_timesheet

  Approve or decline a pending contractor timesheet. Approved hours are queued for the contractor's next payment cycle and paid; an approved timesheet can no longer be changed.

Testing, problems and disconnecting

Everdeck checks the connection when you save it. On the connection’s page in Integrations, Test checks it again at any time.

If Deel later refuses the connection, for example because a key was deleted or a sign-in expired, the connection shows Needs attention on the Integrations page and the people who manage connections are told. Agents can’t use it until a company admin fixes it with Edit or Reconnect.

To stop agents using Deel, open the connection and select Disconnect. Agents stop using it at once and its saved credentials are deleted. What else happens depends on how it was connected: each way above says.