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

# CezanneHR

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

![CezanneHR](https://stackone-logos.com/api/cezanne-hr/filled/svg)

v2.0.0[See changelog](https://docs.stackone.com/connectors/cezannehr/changelog.md)

[54 actions](#actions) · [7 events](#events) · 2 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] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/cezannehr/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> OAuth 2.0 authentication using Client ID and Client Secret from your CezanneHR Authorised Application.

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/cezannehr/guides/connector-profile/oauth-2-0.md)
>
> Requires an Authorised Application created in your CezanneHR instance. Each user signs in to CezanneHR and approves acce...

Optionally, configure receiving Events for CezanneHR into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/cezannehr/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] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/cezannehr/guides/link-account/oauth-2-0-client-credentials.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/cezannehr/guides/link-account/oauth-2-0.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

Scopes

Select all
|
Clear

http\://​www\.cezannehr.com/auth-scope/APIRead

http\://​www\.cezannehr.com/auth-scope/APIWrite

No scopes found

54 actions

ActionDescriptionRequired scopes

List Absence Events`cezannehr_list_absence_events`

Retrieve a list of all absence events

`http://​www.cezannehr.com/auth-scope/APIRead`

List Absence Event Details`cezannehr_list_absence_event_details`

Retrieve detailed breakdown of absence events by day

`http://​www.cezannehr.com/auth-scope/APIRead`

List Absence Plans`cezannehr_list_absence_plans`

Retrieve absence plan assignments for employees

`http://​www.cezannehr.com/auth-scope/APIRead`

Create Absence Event`cezannehr_create_absence_event`

Create a new absence event for an employee

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Update Absence Event`cezannehr_update_absence_event`

Update an existing absence event

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Delete Absence Event`cezannehr_delete_absence_event`

Delete an absence event

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

List Benefits`cezannehr_list_benefits`

Retrieve employee benefit records

`http://​www.cezannehr.com/auth-scope/APIRead`

Create Benefits Record`cezannehr_create_benefits`

Add a benefits record for an employee

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Update Benefits Record`cezannehr_update_benefits`

Update an employee's benefits record

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Delete Benefits Record`cezannehr_delete_benefits`

Delete an employee's benefits record

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

List Companies`cezannehr_list_companies`

Retrieve company records from the system

`http://​www.cezannehr.com/auth-scope/APIRead`

Create Company`cezannehr_create_company`

Create a new company record

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Update Company`cezannehr_update_company`

Update a company record

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Delete Company`cezannehr_delete_company`

Delete a company record

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

List Company Locations`cezannehr_list_locations`

Retrieve company location records

`http://​www.cezannehr.com/auth-scope/APIRead`

List Cost Centres`cezannehr_list_cost_centres`

Retrieve cost centre records

`http://​www.cezannehr.com/auth-scope/APIRead`

List Compensation Records`cezannehr_list_compensation`

Retrieve employee compensation records

`http://​www.cezannehr.com/auth-scope/APIRead`

Create Compensation Record`cezannehr_create_compensation`

Add compensation details for an employee

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Update Compensation Record`cezannehr_update_compensation`

Update an employee's compensation details

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Delete Compensation Record`cezannehr_delete_compensation`

Delete an employee's compensation details

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Search Compensation History`cezannehr_search_compensation_history`

Search employee compensation history

`http://​www.cezannehr.com/auth-scope/APIRead`

List Employees`cezannehr_list_employees`

Retrieve a list of all employees from the People table

`http://​www.cezannehr.com/auth-scope/APIRead`

Create Employee`cezannehr_create_employee`

Create a new employee record in the People table

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Update Employee`cezannehr_update_employee`

Update an existing employee record

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Delete Employee`cezannehr_delete_employee`

Delete an employee record from the People table

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

List Reports To Records`cezannehr_list_reports_to`

Retrieve employee supervisor/reporting relationships

`http://​www.cezannehr.com/auth-scope/APIRead`

List Employment Contracts`cezannehr_list_employment_contracts`

Retrieve employee contract records

`http://​www.cezannehr.com/auth-scope/APIRead`

List Bank Details`cezannehr_list_bank_details`

Retrieve employee bank account records

`http://​www.cezannehr.com/auth-scope/APIRead`

List Employee Photos`cezannehr_list_photos`

Retrieve employee profile photos

`http://​www.cezannehr.com/auth-scope/APIRead`

List Employee Timesheets`cezannehr_list_employee_timesheets`

Retrieve employee timesheet records

`http://​www.cezannehr.com/auth-scope/APIRead`

List Employee Timesheet Details`cezannehr_list_employee_timesheet_details`

Retrieve detailed employee timesheet entries

`http://​www.cezannehr.com/auth-scope/APIRead`

List Addresses`cezannehr_list_addresses`

Retrieve employee address records

`http://​www.cezannehr.com/auth-scope/APIRead`

List Employments`cezannehr_list_employments`

Retrieve a list of all employment records

`http://​www.cezannehr.com/auth-scope/APIRead`

Create Employment`cezannehr_create_employment`

Create a new employment record for an employee

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Update Employment`cezannehr_update_employment`

Update an existing employment record

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Delete Employment`cezannehr_delete_employment`

Delete an employment record

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Person Details Webhook`cezannehr_webhook_person_details`

Processes Cezanne HR person record webhook events (GroupID PEOPLECHANGED), including new hires and leavers, on insert, u...

Communications Webhook`cezannehr_webhook_communications`

Processes Cezanne HR communications record webhook events (GroupID COMMUNICATIONSCHANGED) on insert, update, and delete.

Address Webhook`cezannehr_webhook_address`

Processes Cezanne HR address record webhook events (GroupID ADDRESSCHANGED) on insert, update, and delete.

Marital Status Webhook`cezannehr_webhook_marital_status`

Processes Cezanne HR marital status record webhook events (GroupID MARITALSTATUSECHANGED) on insert, update, and delete.

Bank Details Webhook`cezannehr_webhook_bank_details`

Processes Cezanne HR bank details record webhook events (GroupID BANKDETAILSCHANGED) on insert, update, and delete.

Person Development Activity Webhook`cezannehr_webhook_person_development_activity`

Processes Cezanne HR person development activity webhook events (GroupID PERSONDEVACTIVITYCHANGED) on insert, update, an...

Absence Webhook`cezannehr_webhook_absence`

Processes Cezanne HR absence event webhook events (GroupID PERSONABSENCECHANGED) on insert, update, and delete, per the...

List Jobs`cezannehr_list_jobs`

Retrieve a list of all job definitions

`http://​www.cezannehr.com/auth-scope/APIRead`

Create Job`cezannehr_create_job`

Create a new job definition

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Update Job`cezannehr_update_job`

Update an existing job definition

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Delete Job`cezannehr_delete_job`

Delete a job definition

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

List Organizational Units`cezannehr_list_org_units`

Retrieve a list of all organizational units (departments)

`http://​www.cezannehr.com/auth-scope/APIRead`

Create Organizational Unit`cezannehr_create_org_unit`

Create a new organizational unit

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Update Organizational Unit`cezannehr_update_org_unit`

Update an existing organizational unit

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

Delete Organizational Unit`cezannehr_delete_org_unit`

Delete an organizational unit

`http://​www.cezannehr.com/auth-scope/APIRead``http://​www.cezannehr.com/auth-scope/APIWrite`

List Timesheet Activities`cezannehr_list_timesheet_activities`

Retrieve timesheet activity records

`http://​www.cezannehr.com/auth-scope/APIRead`

List Timesheet Plans`cezannehr_list_timesheet_plans`

Retrieve employee timesheet plan assignments

`http://​www.cezannehr.com/auth-scope/APIRead`

List Timesheet Projects`cezannehr_list_timesheet_projects`

Retrieve timesheet project definitions

`http://​www.cezannehr.com/auth-scope/APIRead`

## Events

Tags

Select all
|
Clear

Absences

Addresses

Bank Accounts

Communications

Development Activities

Employees

Webhooks

No tags found

7 events

EventDescriptionTags

Person Details Webhook`cezannehr_webhook_person_details`

Processes Cezanne HR person record webhook events (GroupID PEOPLECHANGED), including new hires and leavers, on insert, u...

EmployeesWebhooks

Communications Webhook`cezannehr_webhook_communications`

Processes Cezanne HR communications record webhook events (GroupID COMMUNICATIONSCHANGED) on insert, update, and delete.

EmployeesCommunicationsWebhooks

Address Webhook`cezannehr_webhook_address`

Processes Cezanne HR address record webhook events (GroupID ADDRESSCHANGED) on insert, update, and delete.

EmployeesAddressesWebhooks

Marital Status Webhook`cezannehr_webhook_marital_status`

Processes Cezanne HR marital status record webhook events (GroupID MARITALSTATUSECHANGED) on insert, update, and delete.

EmployeesWebhooks

Bank Details Webhook`cezannehr_webhook_bank_details`

Processes Cezanne HR bank details record webhook events (GroupID BANKDETAILSCHANGED) on insert, update, and delete.

EmployeesBank AccountsWebhooks

Person Development Activity Webhook`cezannehr_webhook_person_development_activity`

Processes Cezanne HR person development activity webhook events (GroupID PERSONDEVACTIVITYCHANGED) on insert, update, an...

EmployeesDevelopment ActivitiesWebhooks

Absence Webhook`cezannehr_webhook_absence`

Processes Cezanne HR absence event webhook events (GroupID PERSONABSENCECHANGED) on insert, update, and delete, per the...

AbsencesWebhooks


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