Bulk Create Payslips
Create up to 100 sensitive payslip entries in one SmartHR payroll group. The connected API access token must have payroll Update permission and any applicable employee-field Update permissions.
ActionTry it
Integrate SmartHR
with your AI CRM
SmartHR is a cloud human resources platform for managing employee records, organization data, payroll documents, and HR workflows.
Explore Triggers and Actions
Create Department
Create a SmartHR department. The connected API access token must have the department resource Update permission.
ActionTry it
Create Employee
Create an employee using the documented SmartHR employee fields. The connected API token must have employee resource and field Update permissions.
ActionTry it
Create Employee Custom Field Template
Create an employee custom-field template. The connected API token must have the custom employee field resource Update permission.
ActionTry it
Create Employee Custom Field Template Group
Create an employee custom-field template group.
ActionTry it
Create Employee Dependent
Create a dependent for one employee using the documented family fields. The connected API token must have the required family and employee-field Update permissions.
ActionTry it
Create Employment Type
Create a SmartHR employment type. The connected API access token must have the employment type resource Update permission.
ActionTry it
Create Grade
Create a SmartHR grade. The connected API access token must have the grade resource Update permission.
ActionTry it
Create Job Category
Create a SmartHR job category. The connected API access token must have the job category resource Update permission.
ActionTry it
Create Job Title
Create a SmartHR job title. The connected API access token must have the job title resource Update permission.
ActionTry it
Create Payroll
Create a sensitive SmartHR payroll group. The connected API access token must have payroll Update permission.
ActionTry it
Create Payslip
Create a sensitive employee payslip in one SmartHR payroll group. The connected API access token must have payslip resource Update permission, and employee-field Update permissions may constrain writable data.
ActionTry it
Create Recruitment Type
Create a SmartHR recruitment type. The connected API access token must have the recruitment type resource Update permission.
ActionTry it
Create Tax Withholding
Create a sensitive SmartHR tax-withholding group in the unconfirmed state. The connected API access token must have tax-withholding-group Update permission.
ActionTry it
Create Tax Withholding Slip
Create a file-backed or field-backed sensitive tax-withholding slip for an employee in one SmartHR tax-withholding group. The connected API access token must have the tax-withholding-slip resource and applicable employee-field Update permissions.
ActionTry it
Create User SAML Configuration
Create the SAML SSO account configuration for one SmartHR user. The tenant must have SAML SSO enabled, and the connected API access token must have the user resource Update permission.
ActionTry it
Create Webhook
Create a SmartHR webhook configuration for future employee and dependent events. Matching events can send data to the configured destination, so confirm the URL, event selections, payload exposure, and secret token before calling. The connected API access token must have the webhook resource Update permission.
ActionTry it
Delete Department
Deprecated: delete a SmartHR department by ID. Prefer SMARTHR_DISCONTINUE_DEPARTMENT because SmartHR no longer recommends department deletion. Deletion requires the department resource Update permission and fails when the department or a child department has a scheduled employee update whose effective date has not arrived.
ActionTry it
Delete Employee
Permanently delete one employee by SmartHR employee ID. This requires the employee resource Update permission on the connected access token.
ActionTry it
Delete Employee Custom Field Template
Delete one employee custom-field template by ID. This permanently deletes all employee values set for the template. SmartHR rejects deletion when the field has a scheduled employee update whose effective date has not arrived.
ActionTry it
Delete Employee Custom Field Template Group
Delete one employee custom-field template group by ID. This also permanently deletes every custom-field template in the group and all values set for those templates. SmartHR rejects deletion when a group field has a scheduled employee update whose effective date has not arrived.
ActionTry it
Delete Employee Dependent
Permanently delete one dependent and their sensitive family data from an employee record. This cannot be undone.
ActionTry it
Delete Employment Type
Delete one SmartHR employment type by ID. SmartHR does not allow deletion of a system-standard employment type or one referenced by a scheduled employee update whose effective date has not arrived. The connected API access token must have the employment type resource Update permission.
ActionTry it
Delete Grade
Delete one SmartHR grade by ID. A grade referenced by a scheduled employee update whose effective date has not arrived cannot be deleted. The connected API access token must have the grade resource Update permission.
ActionTry it
Delete Job Category
Delete one SmartHR job category by ID. A job category referenced by a scheduled employee update whose effective date has not arrived cannot be deleted. The connected API access token must have the job category resource Update permission.
ActionTry it
Delete Job Title
Delete one SmartHR job title by ID. A job title referenced by a scheduled employee update whose effective date has not arrived cannot be deleted. The connected API access token must have the job title resource Update permission.
ActionTry it
Delete Payroll
Permanently delete one sensitive SmartHR payroll group by ID. The connected API access token must have the payroll resource Update permission.
ActionTry it
Delete Payslip
Permanently delete one sensitive SmartHR payslip from its payroll group. The connected API access token must have the payslip resource Update permission, and employee fields may also require Update permission.
ActionTry it
Delete Recruitment Type
Delete one SmartHR recruitment type by ID. A recruitment type referenced by a scheduled employee update whose effective date has not arrived cannot be deleted. The connected API access token must have the recruitment type resource Update permission.
ActionTry it
Delete Tax Withholding
Permanently delete one sensitive SmartHR tax-withholding group by ID. The connected API access token must have the tax-withholding-group resource Update permission.
ActionTry it
Delete Tax Withholding Slip
Permanently delete one sensitive SmartHR tax-withholding slip from its tax-withholding group. The connected API access token must have the tax-withholding-slip resource Update permission, and employee fields may also require Update permission.
ActionTry it
Delete User SAML Configuration
Delete the SAML SSO account configuration for one SmartHR user. The tenant must have SAML SSO enabled, and the connected API access token must have the user resource Update permission.
ActionTry it
Delete Webhook
Permanently delete one SmartHR webhook configuration by ID. The connected API access token must have the webhook resource Update permission.
ActionTry it
Disable User SAML Configuration
Disable the SAML SSO account configuration for one SmartHR user. The tenant must have the SAML/SSO option enabled, and the connected API access token must have the user resource Update permission.
ActionTry it
Discontinue Department
Irreversibly discontinue one SmartHR department as of its final active date. The date must be in the past. SmartHR rejects discontinuation when a scheduled employee update references this department or a descendant; the connected access token must have department Update permission.
ActionTry it
Download Batch Job Attachment
Download the binary file for a SmartHR batch-job attachment. SmartHR deletes the provider attachment five minutes after it is retrieved, so use the returned offloaded file reference for subsequent work.
ActionTry it
Enable User SAML Configuration
Enable the SAML SSO account configuration for one SmartHR user. The tenant must have the SAML/SSO option enabled, and the connected API access token must have the user resource Update permission.
ActionTry it
Finalize Payroll
Finalize one sensitive SmartHR payroll group. The connected API access token must have the payroll-group resource Update permission.
ActionTry it
Get Batch Job
Get one SmartHR background batch job by ID, optionally embedding its attachments. The access token needs the corresponding resource Reference permission.
ActionTry it
Get Department
Get one SmartHR department by its department ID.
ActionTry it
Get Employee
Get one employee by SmartHR employee ID, with optional comma-separated field selection. The access token needs employee Reference permission, and returned attributes may be limited by employee-field Reference permissions.
ActionTry it
Get Employee Custom Field Template
Get one employee custom-field template by ID. Set embed to group to include the custom field group that contains the template.
ActionTry it
Get Employee Custom Field Template Group
Get one employee custom-field template group by ID. Set embed to templates to include the custom field templates belonging to the group.
ActionTry it
Get Employee Dependent
Get one dependent belonging to an employee.
ActionTry it
Get Employee Input Form
Get one SmartHR employee information-collection form by ID, preserving its nested field groups, fields, and embedded custom-field definitions.
ActionTry it
Get Employment Type
Get one SmartHR employment type by its employment type ID.
ActionTry it
Get Grade
Get one SmartHR grade by its grade ID.
ActionTry it
Get Job Category
Get one SmartHR job category by its job category ID.
ActionTry it
Get Job Title
Get one SmartHR job title by its job title ID.
ActionTry it
Get Mail Format
Get one SmartHR mail format by ID, optionally embedding the employee information-collection forms that use it.
ActionTry it
Get Payment Period
Get one SmartHR payroll payment period by its payment period ID.
ActionTry it
Get Payroll
Get one sensitive SmartHR payroll group by ID. The access token needs payroll Reference permission, and returned data may contain sensitive financial information.
ActionTry it
Get Payslip
Get one highly sensitive SmartHR payslip from a payroll group. The access token needs payslip Reference permission, and returned employee fields may be permission-filtered.
ActionTry it
Get Recruitment Type
Get one SmartHR recruitment type by its recruitment type ID.
ActionTry it
Get Tax Withholding
Get one highly sensitive SmartHR tax-withholding group by ID. The access token needs tax-withholding-group Reference permission.
ActionTry it
Get Tax Withholding Slip
Get one highly sensitive SmartHR tax-withholding slip from a tax-withholding group. The access token needs tax-withholding-slip Reference permission, and employee fields may be permission-filtered.
ActionTry it
Get User
Get one SmartHR user account by user ID with an optional related object embedded in the response.
ActionTry it
Get User SAML Configuration
Get the SAML SSO account configuration for one SmartHR user. This endpoint requires the tenant's SAML/SSO option to be enabled.
ActionTry it
Get Webhook
Get one SmartHR webhook configuration by webhook ID.
ActionTry it
Invite Employee
Send the documented SmartHR invitation to one employee's configured email address. Repeating the action resends the invitation unless the employee has already accepted it; the inviter must be an administrator.
ActionTry it
List Bank Account Settings
List one page of SmartHR bank-account setting definitions. This does not return employee bank-account values.
ActionTry it
List Batch Jobs
List one page of SmartHR background batch jobs. Optionally embed attachment metadata for each job.
ActionTry it
List Business Establishments
List one page of SmartHR business establishments, optionally embedding the social insurance representative, labor insurance representative, or company.
ActionTry it
List Companies
List one page of SmartHR companies with an optional embedded owner.
ActionTry it
List Departments
List one page of SmartHR departments using the documented code and sort filters. Returns hierarchy and company details when present.
ActionTry it
List Dependent Custom Field Templates
List one page of SmartHR custom-field templates for employee dependents.
ActionTry it
List Dependent Relations
List one page of configured SmartHR dependent relationship types.
ActionTry it
List Employee Custom Field Template Groups
List one page of employee custom-field template groups. Set embed to templates to include the custom fields belonging to each group.
ActionTry it
List Employee Custom Field Templates
List one page of SmartHR employee custom-field templates. Set embed to group to include each template's custom-field group.
ActionTry it
List Employee Dependents
List one page of sensitive family and dependent records for a SmartHR employee. The access token needs dependent Reference permission, and returned fields may be limited by employee-field Reference permissions.
ActionTry it
List Employee Input Forms
List one page of SmartHR employee information-collection forms with their nested field definitions. Set embed to mail_format to include linked mail formats.
ActionTry it
List Employee Maternity and Childcare Leaves
List one page of sensitive maternity and childcare leave records for a SmartHR employee. The access token needs leave-record Reference permission.
ActionTry it
List Employees
List one page of employees matching SmartHR's documented employee filters. Employee records contain sensitive HR data; use fields to request only the attributes needed.
ActionTry it
List Employment Types
List one page of SmartHR employment types.
ActionTry it
List Grades
List one page of SmartHR grades.
ActionTry it
List Job Categories
List one page of SmartHR job categories.
ActionTry it
List Job Titles
List one page of SmartHR job titles using the documented sort option.
ActionTry it
List Mail Formats
List one page of SmartHR mail formats. Set embed to crew_input_forms to include the employee input forms linked to each format.
ActionTry it
List Payment Periods
List one page of SmartHR payroll payment periods.
ActionTry it
List Payrolls
List one page of sensitive SmartHR payroll groups using payment-date and payment-type filters. The access token needs payroll Reference permission.
ActionTry it
List Payslips
List one page of highly sensitive SmartHR payslips in a payroll group. The access token needs payslip Reference permission, and employee fields may be permission-filtered.
ActionTry it
List Recruitment Types
List one page of SmartHR recruitment types.
ActionTry it
List Tax Withholding Slips
List one page of sensitive tax-withholding slips in a SmartHR tax-withholding group. The access token needs tax-withholding-slip Reference permission, and employee fields may be permission-filtered.
ActionTry it
List Tax Withholdings
List one page of sensitive SmartHR tax-withholding groups. The access token needs tax-withholding-group Reference permission.
ActionTry it
List Users
List one page of SmartHR user accounts with the documented sort and embed options, invitation status, role, and email-delivery status.
ActionTry it
List Webhooks
List one page of SmartHR webhook configurations.
ActionTry it
Partially Update Department
Partially update a SmartHR department by ID. The connected API access token must have the department resource Update permission.
ActionTry it
Partially Update Employee Custom Field Template
Partially update an employee custom-field template. Elements apply only to enum templates. When a future-dated employee update is pending for the template, SmartHR permits updating only the hint.
ActionTry it
Partially Update Employment Type
Partially update a SmartHR employment type by ID. SmartHR does not allow renaming a system preset employment type or updating an employment type used by a pending future-dated employee update. The connected API access token must have the employment type resource Update permission.
ActionTry it
Partially Update Payroll
Partially update the administrator-facing and employee-facing names of a sensitive SmartHR payroll group by ID. Both names are required by SmartHR. The connected API access token must have the payroll resource Update permission.
ActionTry it
Partially Update User SAML Configuration
Partially update the SAML SSO account configuration for one SmartHR user. The tenant must have SAML SSO enabled, and the connected API access token must have the user resource Update permission.
ActionTry it
Partially Update Webhook
Partially update a SmartHR webhook by ID. Changing its destination or event selections can redirect future employee and dependent data externally, so confirm them before calling. The connected API access token must have the webhook resource Update permission.
ActionTry it
Publish Payroll
Irreversibly publish one sensitive SmartHR payroll group immediately or at a scheduled time within one month, optionally notifying employees. The connected API access token must have payroll Update permission.
ActionTry it
Remove Employee Departments
Remove all department assignments from one employee using the documented SmartHR endpoint. This requires the employee resource and field Update permissions assigned to the connected access token.
ActionTry it
Reopen Payroll
Reopen one sensitive SmartHR payroll group. Reopening a published payroll may also unpublish it. The connected API access token must have payroll Update permission.
ActionTry it
Replace Department
Replace a SmartHR department through PUT. Omitted optional attributes are deleted; use the partial-update action to preserve attributes that are not being changed. Departments with pending employee updates in their hierarchy cannot be updated.
ActionTry it
Replace Employee Custom Field Template
Replace an employee custom-field template through the documented PUT operation. Omitted optional attributes are deleted; use the PATCH action to preserve attributes that are not being changed. Existing dropdown elements omitted from elements are also deleted.
ActionTry it
Replace Employee Custom Field Template Group
Replace an employee custom-field template group through the documented PUT operation. Omitted optional attributes are deleted; use the PATCH action to preserve attributes that are not being changed.
ActionTry it
Replace Employment Type
Replace a SmartHR employment type through PUT. Attributes omitted from the PUT contract are deleted; use the partial-update action to preserve them. System-standard employment types and employment types used by pending employee updates cannot be changed.
ActionTry it
Replace Grade
Replace a SmartHR grade by ID using full PUT semantics. The PUT contract allows name and rank to be omitted. Grades used by pending future-dated employee updates cannot be changed. The connected API access token must have the grade resource Update permission.
ActionTry it
Replace Job Category
Replace a SmartHR job category by ID using full PUT semantics. The PUT contract allows name to be omitted. Job categories used by pending future-dated employee updates cannot be changed. The connected API access token must have the job category resource Update permission.
ActionTry it
Replace Job Title
Replace a SmartHR job title by ID using full PUT semantics. The PUT contract allows name and rank to be omitted. Job titles used by pending future-dated employee updates cannot be changed. The connected API access token must have the job title resource Update permission.
ActionTry it
Replace Recruitment Type
Replace a SmartHR recruitment type by ID using full PUT semantics. Name is required for the complete replacement. Recruitment types used by pending future-dated employee updates cannot be changed. The connected API access token must have the recruitment type resource Update permission.
ActionTry it
Replace Tax Withholding
Replace a sensitive SmartHR tax-withholding group by ID using full PUT semantics. Name, status, and year are all required for the complete replacement. Finalized tax withholdings cannot be updated. The connected API access token must have the tax-withholding-group resource Update permission.
ActionTry it
Replace Webhook
Replace a SmartHR webhook through PUT. Omitted optional attributes are deleted; use the partial-update action to preserve attributes that are not being changed. Changing its destination or event selections can redirect future employee and dependent data externally, so confirm them before calling.
ActionTry it
Start Dependent Import Job
Start an asynchronous SmartHR dependent-data import from a Base64-encoded CSV or Excel file. This creates a background job that processes sensitive family HR data; the connected API access token must have the corresponding resource and employee-field Update permissions.
ActionTry it
Start Employee Export Job
Start a SmartHR background job that exports employee information using an existing custom download format. A successful 201 response only confirms that the asynchronous job was registered; use the batch-job actions to monitor it and retrieve any resulting attachment. The connected access token must have the required resource and employee-field Update permissions.
ActionTry it
Start Employee Import Job
Start a SmartHR background job that inserts or updates employees from a sensitive base64-encoded CSV or Excel file. The connected API access token must have the required resource and employee-field Update permissions.
ActionTry it
Update Employee
Update the supplied documented fields of one employee by SmartHR employee ID.
ActionTry it
Update Employee Custom Field Template Group
Update one or more supplied fields of an employee custom-field template group.
ActionTry it
Update Employee Dependent
Update the supplied fields of one dependent belonging to an employee.
ActionTry it
Update Grade
Update the supplied fields of a SmartHR grade by ID. Grades used by pending future-dated employee updates cannot be changed. The connected API access token must have the grade resource Update permission.
ActionTry it
Update Job Category
Update the supplied fields of a SmartHR job category by ID. Job categories used by pending future-dated employee updates cannot be changed. The connected API access token must have the job category resource Update permission.
ActionTry it
Update Job Title
Update the supplied fields of a SmartHR job title by ID. Job titles used by pending future-dated employee updates cannot be changed. The connected API access token must have the job title resource Update permission.
ActionTry it
Update Recruitment Type
Update a SmartHR recruitment type by ID. Recruitment types used by pending future-dated employee updates cannot be changed. The connected API access token must have the recruitment type resource Update permission.
ActionTry it
Update Tax Withholding
Update the supplied fields of a sensitive SmartHR tax-withholding group by ID. SmartHR does not allow updates after the group is fixed. The connected API access token must have the tax-withholding-group resource Update permission.
ActionTry it
Update Tax Withholding Slip
Update a sensitive SmartHR tax-withholding slip. The full body is required: structured updates require the complete identity, payer, tax-year, and payment body, and sparse field updates are rejected by SmartHR. Confirmed slips cannot be updated, and switching between file-backed and field-backed data requires deleting and recreating the slip. The connected API access token must have the tax-withholding-slip resource Update permission.
ActionTry it
How the SmartHR integration works
The SmartHR integration connects your Dench AI CRM directly to SmartHR, so agents can read and act on your SmartHR data as part of everyday work — answering questions in chat, keeping your CRM in sync, and running automations without anyone copying data between tools.
117 actions are available for agents to invoke on your behalf. Every call runs through SmartHR's own authorization, scoped to the account you connect.
Set up SmartHR in Dench
- 1
Sign in to your Dench workspace and open Integrations.
- 2
Find SmartHR and click Connect — you'll authorize access through SmartHR's own sign-in flow. No API keys or code required.
- 3
Ask an agent to use SmartHR in chat, or call it from an automation.
- 4
Manage or disconnect the connection any time from workspace settings.
Frequently asked questions
How does the SmartHR integration work with Dench?
The Dench SmartHR integration connects your AI CRM to SmartHR, so AI agents can work with your SmartHR data as part of chats, automations, and CRM workflows. You connect your account once, and every agent in your workspace can use it — governed by your workspace permissions.
What actions can AI agents perform with SmartHR via Dench?
The SmartHR integration currently exposes 117 actions, including Bulk Create Payslips, Create Department, Create Employee, Create Employee Custom Field Template, Create Employee Custom Field Template Group, and Create Employee Dependent. Agents invoke them on your behalf from chat or from automations.
Do I need to write code to connect SmartHR to Dench?
No. You connect SmartHR from your Dench workspace using SmartHR's own sign-in and authorization flow — no API keys to copy, no glue code to maintain.
Is the SmartHR integration secure?
Connections are authorized through SmartHR's own authentication flow, and Dench stores only the authorization needed to act on your behalf. You can review and disconnect the SmartHR connection from your workspace settings at any time.