> ## 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.

# Remote

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

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

v3.1.2[See changelog](https://docs.stackone.com/connectors/remote/changelog.md)

[69 actions](#actions) · [50 events](#events) · 4 auth methods

HRIS

## 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/remote/guides/connector-profile/api-token.md)
>
> No app registration required. Uses an API token created in Remote with Read Only or Full Access to its endpoint collecti...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/remote/guides/connector-profile/oauth-2-0.md)
>
> Uses partner OAuth credentials that Remote's partnerships team provisions. A company Owner or Admin approves access to t...

> [card] [OAuth 2.0 Client Credentials · Connector Profile](https://docs.stackone.com/connectors/remote/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Uses partner OAuth credentials that Remote's partnerships team provisions. The token acts as the partner integration rat...

> [card] [OAuth 2.0 JWT Assertion (Company Manager) · Connector Profile](https://docs.stackone.com/connectors/remote/guides/connector-profile/oauth-2-0-jwt-assertion-company-manager.md)
>
> Actions run as one Remote company manager with no sign-in screen, and reach only that manager's company. Uses partner OA...

Optionally, configure receiving Events for Remote into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/remote/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/remote/guides/link-account/api-token.md)

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

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

> [card] [OAuth 2.0 JWT Assertion (Company Manager) · Link Account](https://docs.stackone.com/connectors/remote/guides/link-account/oauth-2-0-jwt-assertion-company-manager.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

Authentication type

Select all
|
Clear

API Token

OAuth 2.0

OAuth 2.0 Client Credentials

OAuth 2.0 JWT Assertion (Company Manager)

No auth methods found

Scopes

Select all
|
Clear

benefit\_offer:read

company:read

company:write

company\_admin

company\_department:read

company\_department:write

company\_manager:read

company\_manager:write

contract\_amendment:read

country:read

custom\_field:read

custom\_field:write

custom\_field\_value:read

custom\_field\_value:write

document:read

document:write

employment:read

employment:write

expense:read

expense:write

form:read

incentive:read

incentive:write

invoices:read

offboarding:read

offboarding:write

payroll\_run:read

payslip:read

timeoff:read

timeoff:write

timesheet:read

timesheet:write

webhook:read

webhook:write

No scopes found

69 actions

ActionDescriptionRequired scopes

List Benefit Offers`remote_list_benefit_offers`

Retrieve a paginated list of all benefit offers

`benefit_offer:read`

List Companies`remote_list_companies`

List all companies that authorized your integration

`company:read`

Get Company`remote_get_company`

Retrieve details of a specific company by ID

`company:read`

Create Company`remote_create_company`

Create a new company

`company:write`

Update Company`remote_update_company`

Update an existing company

`company:write`

List Company Legal Entities`remote_list_company_legal_entities`

List all legal entities for a company

`company:read`

List Company Managers`remote_list_company_managers`

List all company managers

`company_manager:read`

Get Company Manager`remote_get_company_manager`

Get details of a specific company manager

`company_manager:read`

Create Company Manager`remote_create_company_manager`

Create and invite a company manager

`company_manager:write`

Delete Company Manager`remote_delete_company_manager`

Delete a company manager user

`company_manager:write`

Get Contract Amendment Schema`remote_get_contract_amendment_schema`

Retrieve the contract amendment form schema for an employment

`contract_amendment:read`

List Contractor Invoices`remote_list_contractor_invoices`

List all contractor invoices with filtering and pagination

`invoices:read`

Get Contractor Invoice`remote_get_contractor_invoice`

Retrieve details of a specific contractor invoice by ID

`invoices:read`

List Countries`remote_list_countries`

List all countries supported by Remote API

`country:read`

List Country Holidays`remote_list_country_holidays`

Retrieve the list of public holidays for a specific country and year

`country:read`

Get Country Form Schema`remote_get_country_form_schema`

Retrieve the JSON schema for a specific form type and country

`form:read``company_admin`

List Custom Fields`remote_list_custom_fields`

List all custom field definitions

`custom_field:read`

Create Custom Field`remote_create_custom_field`

Create a new custom field definition

`custom_field:write`

Get Custom Field Value`remote_get_custom_field_value`

Get a custom field value for a specific employment

`custom_field_value:read`

Update Custom Field Value`remote_update_custom_field_value`

Update a custom field value for a specific employment

`custom_field_value:write`

List Employment Custom Fields`remote_list_employment_custom_fields`

List custom field values for a specific employment

`custom_field_value:read`

List Departments`remote_list_departments`

List all departments for a company

`company_department:read`

Create Department`remote_create_department`

Create a new department

`company_department:write`

List Employments`remote_list_employments`

List all employments except deleted ones

`employment:read`

Get Employment`remote_get_employment`

Show all information of an employment

`employment:read`

Create Employment`remote_create_employment`

Create a new employment record

`employment:write`

Update Employment`remote_update_employment`

Update an existing employment record

`employment:write`

List Expenses`remote_list_expenses`

List all expense records

`expense:read`

Get Expense`remote_get_expense`

Show a single expense record

`expense:read`

Create Expense`remote_create_expense`

Create an approved expense

`expense:write`

Update Expense`remote_update_expense`

Update an expense status

`expense:write`

List Employment Files`remote_list_employment_files`

List files associated with an employment

`document:read`

Download File`remote_download_file`

Download a file by ID

`document:read`

Upload File`remote_upload_file`

Upload a file for an employment

`document:write`

List Incentives`remote_list_incentives`

Retrieve a paginated list of all incentives

`incentive:read`

Get Incentive`remote_get_incentive`

Retrieve details of a specific incentive by ID

`incentive:read`

Create Incentive`remote_create_incentive`

Create a new incentive for an employment

`incentive:write`

Update Incentive`remote_update_incentive`

Update an existing incentive

`incentive:write`

Delete Incentive`remote_delete_incentive`

Delete an incentive

`incentive:write`

List Recurring Incentives`remote_list_recurring_incentives`

List all recurring incentives

`incentive:read`

Create Recurring Incentive`remote_create_recurring_incentive`

Create a monthly paid recurring incentive

`incentive:write`

Delete Recurring Incentive`remote_delete_recurring_incentive`

Delete a recurring incentive

`incentive:write`

List Leave Policies Summary`remote_list_leave_policies_summary`

List time off balances and entitlements for an employment

`timeoff:read`

List Leave Policies Details`remote_list_leave_policies_details`

List leave policy configurations for an employment

`timeoff:read`

List Offboardings`remote_list_offboardings`

Retrieve a paginated list of all offboarding records

`offboarding:read`

Get Offboarding`remote_get_offboarding`

Retrieve details of a specific offboarding record

`offboarding:read`

Create Offboarding`remote_create_offboarding`

Initiate an offboarding process for an employment

`offboarding:write`

List Payslips`remote_list_payslips`

Retrieve a paginated list of all payslips

`payslip:read`

Get Payslip`remote_get_payslip`

Retrieve details of a specific payslip by ID

`payslip:read`

List Payroll Runs`remote_list_payroll_runs`

Retrieve a paginated list of all payroll runs

`payroll_run:read`

Get Payroll Run`remote_get_payroll_run`

Retrieve details of a specific payroll run by ID

`payroll_run:read`

Get Payroll Run Employee Details`remote_get_payroll_run_employee_details`

Retrieve employee details for a specific payroll run

`payroll_run:read`

List Time Off Requests`remote_list_timeoffs`

Retrieve a paginated list of all time off requests

`timeoff:read`

Get Time Off Request`remote_get_timeoff`

Retrieve details of a specific time off request by ID

`timeoff:read`

List Time Off Types`remote_list_timeoff_types`

List all available time off types

`timeoff:read`

Create Time Off Request`remote_create_timeoff`

Create a new approved time off request

`timeoff:write`

Update Time Off Request`remote_update_timeoff`

Update a time off request

`timeoff:write`

Approve Time Off Request`remote_approve_timeoff`

Approve a pending time off request

`timeoff:write`

Decline Time Off Request`remote_decline_timeoff`

Decline a pending time off request

`timeoff:write`

Cancel Time Off Request`remote_cancel_timeoff`

Cancel an approved time off request

`timeoff:write`

Approve Time Off Cancellation Request`remote_approve_cancel_request`

Approve a time off cancellation request

`timeoff:write`

Decline Time Off Cancellation Request`remote_decline_cancel_request`

Decline a time off cancellation request

`timeoff:write`

List Timesheets`remote_list_timesheets`

List all timesheets

`timesheet:read`

Get Timesheet`remote_get_timesheet`

Get details of a specific timesheet

`timesheet:read`

Approve Timesheet`remote_approve_timesheet`

Approve a submitted timesheet

`timesheet:write`

List Webhooks`remote_list_webhooks`

Retrieve a list of all registered webhook callbacks

`webhook:read`

Create Webhook`remote_create_webhook`

Register a new webhook callback

`webhook:write`

Update Webhook`remote_update_webhook`

Update a registered webhook callback

`webhook:write`

Delete Webhook`remote_delete_webhook`

Delete a registered webhook callback

`webhook:write`

## Events

Tags

Select all
|
Clear

Companies

Employments

Expenses

Offboardings

Payslips

Time Off

No tags found

50 events

EventDescriptionTags

Company Activated`remote_webhook_company_activated`

Processes the Remote company.activated event.

Companies

Company Archived`remote_webhook_company_archived`

Processes the Remote company.archived event.

Companies

Company Manager Created`remote_webhook_company_manager_created`

Processes the Remote company.manager\_created event.

Companies

Company Manager Updated`remote_webhook_company_manager_updated`

Processes the Remote company.manager\_updated event.

Companies

Company Manager Deleted`remote_webhook_company_manager_deleted`

Processes the Remote company.manager\_deleted event.

Companies

Company Owner Changed`remote_webhook_company_owner_changed`

Processes the Remote company.owner\_changed event.

Companies

Company Pricing Plan Updated`remote_webhook_company_pricing_plan_updated`

Processes the Remote company.pricing\_plan.updated event.

Companies

Employment Updated`remote_webhook_employment_updated`

Processes the Remote employment.updated event.

Employments

Employment Status Updated`remote_webhook_employment_status_updated`

Processes the Remote employment.status.updated event.

Employments

Employment Account Updated`remote_webhook_employment_account_updated`

Processes the Remote employment.account.updated event.

Employments

Employment Details Updated`remote_webhook_employment_details_updated`

Processes the Remote employment.details.updated event.

Employments

Employment Personal Information Updated`remote_webhook_employment_personal_information_updated`

Processes the Remote employment.personal\_information.updated event.

Employments

Employment Work Email Updated`remote_webhook_employment_work_email_updated`

Processes the Remote employment.work\_email.updated event.

Employments

Employment Employment Agreement Available`remote_webhook_employment_employment_agreement_available`

Processes the Remote employment.employment\_agreement.available event.

Employments

Employment Start Date Changed`remote_webhook_employment_start_date_changed`

Processes the Remote employment.start\_date.changed event.

Employments

Employment Benefits Selected`remote_webhook_employment_benefits_selected`

Processes the Remote employment.benefits.selected event.

Employments

Employment Onboarding Started`remote_webhook_employment_onboarding_started`

Processes the Remote employment.onboarding.started event.

Employments

Employment Onboarding Completed`remote_webhook_employment_onboarding_completed`

Processes the Remote employment.onboarding.completed event.

Employments

Employment Onboarding Cancelled`remote_webhook_employment_onboarding_cancelled`

Processes the Remote employment.onboarding.cancelled event.

Employments

Employment Onboarding Task Completed`remote_webhook_employment_onboarding_task_completed`

Processes the Remote employment.onboarding\_task.completed event.

Employments

Employment User Status Initiated`remote_webhook_employment_user_status_initiated`

Processes the Remote employment.user\_status.initiated event.

Employments

Employment User Status Invited`remote_webhook_employment_user_status_invited`

Processes the Remote employment.user\_status.invited event.

Employments

Employment User Status Activated`remote_webhook_employment_user_status_activated`

Processes the Remote employment.user\_status.activated event.

Employments

Employment User Status Deactivated`remote_webhook_employment_user_status_deactivated`

Processes the Remote employment.user\_status.deactivated event.

Employments

Employment Contractor Of Record Termination Initiated`remote_webhook_employment_contractor_of_record_termination_initiated`

Processes the Remote employment.contractor\_of\_record\_termination.initiated event.

Employments

Employment Contractor Of Record Termination Executed`remote_webhook_employment_contractor_of_record_termination_executed`

Processes the Remote employment.contractor\_of\_record\_termination.executed event.

Employments

Employment Contractor Of Record Termination Cancelled`remote_webhook_employment_contractor_of_record_termination_cancelled`

Processes the Remote employment.contractor\_of\_record\_termination.cancelled event.

Employments

Contract Termination Date Reached`remote_webhook_contract_termination_date_reached`

Processes the Remote contract.termination\_date\_reached event.

Employments

Expense Submitted`remote_webhook_expense_submitted`

Processes the Remote expense.submitted event.

Expenses

Expense Approved`remote_webhook_expense_approved`

Processes the Remote expense.approved event.

Expenses

Expense Declined`remote_webhook_expense_declined`

Processes the Remote expense.declined event.

Expenses

Expense Reimbursed`remote_webhook_expense_reimbursed`

Processes the Remote expense.reimbursed event.

Expenses

Expense Updated`remote_webhook_expense_updated`

Processes the Remote expense.updated event.

Expenses

Expense Deleted`remote_webhook_expense_deleted`

Processes the Remote expense.deleted event.

Expenses

Offboarding Submitted`remote_webhook_offboarding_submitted`

Processes the Remote offboarding.submitted event.

Offboardings

Offboarding Review Started`remote_webhook_offboarding_review_started`

Processes the Remote offboarding.review\_started event.

Offboardings

Offboarding Submitted To Payroll`remote_webhook_offboarding_submitted_to_payroll`

Processes the Remote offboarding.submitted\_to\_payroll event.

Offboardings

Offboarding Completed`remote_webhook_offboarding_completed`

Processes the Remote offboarding.completed event.

Offboardings

Offboarding Done`remote_webhook_offboarding_done`

Processes the Remote offboarding.done event.

Offboardings

Offboarding Deleted`remote_webhook_offboarding_deleted`

Processes the Remote offboarding.deleted event.

Offboardings

Payslip Released`remote_webhook_payslip_released`

Processes the Remote payslip.released event.

Payslips

Timeoff Requested`remote_webhook_timeoff_requested`

Processes the Remote timeoff.requested event.

Time Off

Timeoff Approved`remote_webhook_timeoff_approved`

Processes the Remote timeoff.approved event.

Time Off

Timeoff Declined`remote_webhook_timeoff_declined`

Processes the Remote timeoff.declined event.

Time Off

Timeoff Cancellation Requested`remote_webhook_timeoff_cancellation_requested`

Processes the Remote timeoff.cancellation\_requested event.

Time Off

Timeoff Canceled`remote_webhook_timeoff_canceled`

Processes the Remote timeoff.canceled event.

Time Off

Timeoff Date Changed`remote_webhook_timeoff_date_changed`

Processes the Remote timeoff.date\_changed event.

Time Off

Timeoff Updated`remote_webhook_timeoff_updated`

Processes the Remote timeoff.updated event.

Time Off

Timeoff Started`remote_webhook_timeoff_started`

Processes the Remote timeoff.started event.

Time Off

Timeoff Taken`remote_webhook_timeoff_taken`

Processes the Remote timeoff.taken event.

Time Off


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