---
title: "Perform an action on an embed onboarding task"
method: POST
path: "/onboarding/v2/embed:action"
tags: ["Onboarding Embed"]
---

# Perform an action on an embed onboarding task

`POST /onboarding/v2/embed:action`

## Request

- Base URL: `https://your-subdomain.deputy.deputy.com/api`
- URL: `https://your-subdomain.deputy.deputy.com/api/onboarding/v2/embed:action`
- Auth: API key in header `OAuth`

Perform an action on an embed onboarding task.

## Response `200`

A successful response.

- OnboardingDashboardPerformEmbedOnboardingActionResponse
  - `success` boolean
  - `status` EmbedEmbedOnboardingStatus
    - `isCompletedOnboarding` boolean
    - `nextStep` 'UNKNOWN' | 'SCHEDULING_RULES' | 'CREATE_SHIFT' | 'PUBLISH_ROSTER' | 'DISCOVER_EMPLOYEE_EXPERIENCE' | 'INVITE_EMPLOYEES' | 'SETUP_PAY_RULES' | 'APPROVE_TIMESHEETS' | 'SEND_TIMESHEETS_TO_PAYROLL': - UNKNOWN: The task is unknown - SCHEDULING_RULES: Set up scheduling rules (e.g location configuration) - CREATE_SHIFT: Create a shift - PUBLISH_ROSTER: Publish a roster - DISCOVER_EMPLOYEE_EXPERIENCE: Discover employee experience - INVITE_EMPLOYEES: Invite employees - SETUP_PAY_RULES: Set up pay rules - APPROVE_TIMESHEETS: Approve timesheets - SEND_TIMESHEETS_TO_PAYROLL: Send timesheets to payroll
    - `onboardingTasks` EmbedEmbedOnboardingTask[]
      - `name` 'UNKNOWN' | 'SCHEDULING_RULES' | 'CREATE_SHIFT' | 'PUBLISH_ROSTER' | 'DISCOVER_EMPLOYEE_EXPERIENCE' | 'INVITE_EMPLOYEES' | 'SETUP_PAY_RULES' | 'APPROVE_TIMESHEETS' | 'SEND_TIMESHEETS_TO_PAYROLL': - UNKNOWN: The task is unknown - SCHEDULING_RULES: Set up scheduling rules (e.g location configuration) - CREATE_SHIFT: Create a shift - PUBLISH_ROSTER: Publish a roster - DISCOVER_EMPLOYEE_EXPERIENCE: Discover employee experience - INVITE_EMPLOYEES: Invite employees - SETUP_PAY_RULES: Set up pay rules - APPROVE_TIMESHEETS: Approve timesheets - SEND_TIMESHEETS_TO_PAYROLL: Send timesheets to payroll
      - `isCompleted` boolean
      - `sortOrder` integer: Sort order for displaying the task in FE.
      - `completedAt` string, date-time

---

[API](https://skmtc.dev/deputy/apis/deputy-v2-api.md) - [All operations](https://skmtc.dev/deputy/apis/deputy-v2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/deputy/apis/deputy-v2-api/revisions/78f0278f4608?raw)