Skip to main content

App Integration Framework

What Is It?

The App Integration framework allows the creation of custom webhook-based integrations with external systems. Each “app” defines one or more action events — HTTP requests that can be executed from automations to send data to or retrieve data from third-party services.

How Apps Work

Each app contains action events, and each action event defines:
SettingDescription
NameA descriptive name for the action
HTTP MethodGET, POST, PUT, DELETE, or PATCH
URLThe endpoint to call — supports dynamic variable references
AuthenticationNone, Basic Auth, or Bearer Token
Accepted Status CodesWhich HTTP response codes indicate success
Custom HeadersOptionally allow custom HTTP headers
Custom Request BodyOptionally allow a custom request payload
Custom Output VariablesOptionally allow custom response mapping

Request Body

For methods that support a body (POST, PUT, PATCH, DELETE), the body can be configured as:
  • JSON — Structured JSON with dynamic variable references
  • Form Data — Key-value pairs
  • URL-Encoded — Standard form encoding

Input Variables

Each action event can define input variables that act as parameters. These have a name, type (text, number, or file), helper text, and a required flag. When the integration is used in an automation, admins map data from the candidate’s profile to these inputs.

Output Variables

Output variables capture values from the API response. Each has a field name, type (text or number), and display name. Output variables can be added manually or extracted automatically from a sample JSON response.

Usage in Automations

The Integration Action in the automation builder lets admins select an app and its action event, map input variables from the candidate’s data, and map output variables to form fields or workflow parameters.

Check-in Forms

What Are They?

Check-in Forms are recurring data collection forms designed for active workers. Unlike hiring flow forms (which are completed once during the application process), check-in forms can be sent repeatedly to gather ongoing information — compliance updates, shift confirmations, health checks, performance reviews, and more.

How They Work

Check-in forms use the same Form Builder as hiring flows. Admins can:
  • Design multi-page forms with any combination of question types
  • Attach compliance rules for automated evaluation
  • Configure data connectors to pre-fill fields
  • View all submissions in a centralized list

Submission Flow

When a worker receives a check-in form:
  1. They open the form from their task list or a direct link
  2. Pages are presented one at a time
  3. Compliance rules evaluate submissions as each page is completed
  4. On completion, the submission status is updated

Submission Statuses

StatusDescription
Waiting ListWorker is queued
Pending ReviewSubmission awaits admin review
SuccessSubmission accepted
RejectedSubmission rejected

Integration with Automations

CapabilityDescription
Send Check-in FormAn automation action that sends a check-in form to a worker
Update StatusAn automation action that changes a check-in form submission’s status
TriggerAutomations can be scoped to check-in forms, responding to submission events

People & Onboarding

What Is It?

The People module (also called Onboarding Flows) manages the post-hire experience. When a candidate is converted to a worker (via contract creation), they are assigned an onboarding flow that guides them through required steps — forms, documents, training, and more.

Onboarding Flow Structure

Each onboarding flow contains the same components as a hiring flow:
  • Form Builder — Design the onboarding form with pages and questions
  • Analytics — Track onboarding progress and completion
  • Templates — Email and SMS templates for communication
  • Custom Variables — Computed fields based on worker data
  • Contract Fields — Configure which contract fields are visible

Worker Onboarding Experience

When a worker logs in:
  1. If onboarding is pending, they are directed to the onboarding flow
  2. They complete pages one at a time (forms, documents, signatures, etc.)
  3. On completion, they transition to the active worker dashboard

Recollection

If specific documents or fields need to be re-submitted, the worker is prompted to re-collect those items — following the same recollection process as hiring flows.

Integration with Automations

  • Contract Creation action: Converts a hiring flow application into a contract with an assigned onboarding flow
  • Update Worker Stage action: Changes the worker’s contract status
  • Automations scoped to the People/Onboarding context respond to contract-related events

Reports & Analytics

What Is It?

The Reports module provides dashboards and visualizations for tracking operational metrics across the platform.

Capabilities

  • Custom dashboards — Create and configure dashboards with multiple charts
  • Analytics per flow — Each hiring flow and onboarding flow has a built-in analytics tab
  • Stage group analytics — Track progression through grouped stages for funnel analysis
  • Filterable data — Apply filters to narrow down metrics by time period, stage, status, and more
  • Exports — Download report data for external analysis

Tasks

What Is It?

Tasks are a manual review queue where admins handle items that require human judgment — approvals, rejections, document reviews, and other flagged items.

How Tasks Work

Tasks are created automatically by:
  • The Send for Manual Review automation action
  • Compliance rules that route candidates to manual review
  • System events that require admin attention
Each task includes a title, description, priority, reporter, due date, and an action that navigates the admin to the relevant record.

Task Statuses

StatusDescription
PendingNot yet started
In ProgressBeing worked on
CompletedMarked as done
Workers also see tasks assigned to them — such as completing a check-in form, finishing a course, or responding to a recollection request.

Payroll

Firstwork integrates with Deel for payroll management. The payroll section provides embedded access to the Deel platform directly within the Firstwork admin interface.

Execution Logs

Execution logs provide a comprehensive audit trail across the platform, organized into:
Log CategoryWhat It Tracks
Automation LogsAll automation execution records with status, timing, and action details
Navigation LogsCompliance rule decisions about page navigation
Communication LogsEmails, SMS messages, and Slack notifications sent
Idle Rule LogsAutomations triggered on idle records