Skip to content
← Back to documentation
Technical Reference

Omni HR

Smart, all-in-one HR platform for managing employees, time tracking, and HR workflows

CategoryHuman Resources
Authenticationcustom
Version0.2.0
Published scopes0 published scopes
Last updatedSeptember 21, 2026

Overview

Connect Omni HR with Flows360

Smart, all-in-one HR platform for managing employees, time tracking, and HR workflows

Use the Omni HR connector to include its declared actions and events in Flows360 workflows without duplicating the integration logic inside each consuming system. This pinned connector version currently exposes 6 actions and no declared triggers.

Available actions

  • Get Employee System ID by Email
  • Get Employee Details by System ID
  • Get Employee Organizational Chart
  • Get Employee Direct Reports
  • Generate Report
  • Custom API Call

Available triggers

  • No triggers are declared in this pinned package.

The capability list above is generated from the exact reviewed connector package so the public description stays aligned with the version Flows360 operates.

Technical guide

Technical reference

Package identity

  • Connector: Omni HR
  • Package: @activepieces/piece-omnihr@0.2.0
  • Exact artifact digest: sha256:c0822412561f89cf2cd7a89a5313c10d966343703104881c482d79706dade5da
  • Runtime: Activepieces-compatible deterministic worker
  • Source: the exact reviewed Activepieces source

Authentication

CUSTOM AUTH. Connection values are tenant-specific and remain in the consuming Studio instance; CDK stores definitions and field metadata, not customer credential values.

Action contracts

  • Get Employee System ID by Email (get_employee_system_id), Searches for an employee by email and returns their system ID and user ID Classification: read.
  • Get Employee Details by System ID (get_employee_info), Retrieves detailed employee information using their system ID Classification: read.
  • Get Employee Organizational Chart (get_employee_organizational_chart), Retrieves employee organizational relationships including the complete management chain, direct reports, and peers Classification: read.
  • Get Employee Direct Reports (get_direct_reports), Retrieves a list of employees who directly report to the specified employee Classification: read.
  • Generate Report (generateReport), Generate Custom Report. For Snapshot report templates, optionally generate the report as of a past date Classification: read.
  • Custom API Call (custom_api_call), Make a custom API call to a specific endpoint Classification: read.

Trigger contracts

  • No trigger delivery contracts are declared.

Verification

Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Capability summary

Authenticationcustom
Supported objects6
Supported actions6
TriggersNone published

Authentication

Authentication method: custom

Authentication profiles

connection · custom
  • Username Required
  • Password Required · protected credential
  • Origin Required

Supported objects

ObjectReadWriteNotes
Get Employee System ID by Email Yes No Searches for an employee by email and returns their system ID and user ID
Get Employee Details by System ID Yes No Retrieves detailed employee information using their system ID
Get Employee Organizational Chart Yes No Retrieves employee organizational relationships including the complete management chain, direct reports, and peers
Get Employee Direct Reports Yes No Retrieves a list of employees who directly report to the specified employee
Generate Report Yes No Generate Custom Report. For Snapshot report templates, optionally generate the report as of a past date
Custom API Call Yes No Make a custom API call to a specific endpoint

Supported actions

Get Employee System ID by Email · Read

Searches for an employee by email and returns their system ID and user ID

get_employee_system_id · Risk: low · Retry: safe

Inputs

  • email · string · Required, The email address of the employee to look up
  • employmentStatuses · array · Required, Select one or more status
Get Employee Details by System ID · Read

Retrieves detailed employee information using their system ID

get_employee_info · Risk: low · Retry: safe

Inputs

  • system_id · number · Required, The system ID of the employee
Get Employee Organizational Chart · Read

Retrieves employee organizational relationships including the complete management chain, direct reports, and peers

get_employee_organizational_chart · Risk: low · Retry: safe

Inputs

  • system_id · number · Required, The system ID of the employee
Get Employee Direct Reports · Read

Retrieves a list of employees who directly report to the specified employee

get_direct_reports · Risk: low · Retry: safe

Inputs

  • system_id · number · Required, The user ID of the employee
Generate Report · Read

Generate Custom Report. For Snapshot report templates, optionally generate the report as of a past date

generate_report · Risk: low · Retry: safe

Inputs

  • reportTemplateId · string · Required, The custom report template to generate a report from
  • snapshotOptions · object · Optional
  • mapFieldNames · boolean · Optional, If enabled, row keys are mapped from field IDs to their human-readable names as defined in the report template. Any field that cannot be mapped keeps its ID. Caveat: if two fields share the same name, only one will appear in the output as the other is overwritten.
Custom API Call · Read

Make a custom API call to a specific endpoint

custom_api_call · Risk: low · Retry: safe

Inputs

  • url · object · Required
  • method · string · Required
  • headers · object · Optional, Authorization headers are injected automatically from your connection.
  • queryParams · object · Optional, Appended to the URL as ?key=value.
  • body_type · string · Optional
  • body · object · Optional
  • response_is_binary · boolean · Optional, Enable for files like PDFs, images, etc.
  • failsafe · boolean · Optional, On a failed request, output the error instead of failing the step.
  • timeout · number · Optional, Seconds to wait for a response. Empty: up to the flow limit (10 min).
  • followRedirects · boolean · Optional, Follow 3xx redirects instead of returning them as the response.

Setup

Setup

  1. Add the Omni HR connector to the workflow in the target Flows360 Studio instance.
  2. Create or select the tenant-specific connection required by the connector. Connection secrets remain in the Studio connection boundary and are not copied into CDK documentation.
  3. Provide the connection fields declared by the pinned package:
  • Username (username), required.
  • Password (password), required; stored as a sensitive connection value.
  • Origin (origin), required.
  1. Select the required action or trigger and complete its declared input fields. Required and optional inputs are defined by the exact package schema.
  2. Test the workflow in the appropriate environment before enabling production scheduling or event delivery.

Limitations

Limitations and operational notes

  • This content describes @activepieces/piece-omnihr@0.2.0; provider behaviour can change independently and should be revalidated when the provider or connector version changes.
  • Only the 6 actions and 0 triggers declared by this pinned package are represented here.
  • Tenant credentials and connection values are not stored in the public connector record.
  • Provider-side permissions, account entitlements, quotas and rate limits remain subject to the connected provider account and are not inferred when the package does not declare them.
  • Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Troubleshooting

Why canu2019t the connector authenticate?

Check the tenant connection in Studio and confirm every required Omni HR connection field is present. Re-authorise OAuth-based connections if the provider token or consent has expired. Do not place credential values in CDK content or logs.

Why is an action or trigger unavailable?

Confirm that the workflow is using @activepieces/piece-omnihr@0.2.0 and compare the requested capability with the declared action and trigger list for this version. A capability that is not declared by the pinned package should not be presented as supported.

What should I check after a provider-side change?

Revalidate authentication, required fields, action/trigger behaviour and provider documentation before publishing refreshed connector content or moving a new package version into production.