How to connect your ERP with Sesame using the REST API
Integrating a corporate ERP with an HR platform is one of the most common digitalization projects in enterprise companies. Sesame HR makes this integration straightforward thanks to its REST API, documented under the OpenAPI 3.0 specification, which allows you to synchronize employee data, organizational structures, and HR events in an automated way.
Keeping data in sync between your ERP and Sesame HR eliminates duplicate information, reduces manual data entry errors, and allows IT, finance, and HR teams to work from a single source of truth.
Integration process
💡 Before you begin, make sure the API Add-on is activated on your Sesame HR account and that you have your authentication token ready. |
1. Authentication
The Sesame HR API uses Bearer Token authentication. Administrators can generate and manage tokens from the admin panel under Configuration > Integrations > API. Every API request must include the token in the authorization header.
|
GET /core/v3/employees Host: api-eu1.sesametime.com Authorization: Bearer {your_token} Accept: application/json |
2. Entity mapping
Before starting the synchronization, you need to map the ERP entities to those in Sesame HR. The main resources to map are:
ERP entity |
Sesame API resource |
Endpoint |
Employee / Worker |
Employees |
/core/v3/employees |
Department / Unit |
Departments |
/core/v3/departments |
Cost centre / Site |
Offices |
/core/v3/offices |
Employment contract |
Contracts |
/contract/v1/contracts |
Salary data |
Salaries |
/contract/v1/salaries |
3. Syncing hires and leavers
When a new employee is created in the ERP, their profile can be automatically created in Sesame HR by triggering a POST request to the employees endpoint. Similarly, when an employee leaves in the ERP, their record can be updated or deactivated in Sesame.
|
POST /core/v3/employees Content-Type: application/json Authorization: Bearer {your_token}
{ "firstName": "Amy", "lastName": "Adams", "email": "amy.adams@company.com", "departmentId": "uuid-of-department", "officeId": "uuid-of-office" } |
4. Transferring payroll variables
Sesame HR can act as the source of truth for payroll-affecting events. Through the API you can automatically export the following to your payroll system:
- Overtime hours and clock ins/outs: via the Work Entries endpoints (/schedule/v1/work-entries).
- Time off and absences: via Time Off and Absence Day Off Requests (/schedule/v1/vacation-day-off-requests).
- Monthly variable compensation: via Monthly Variable Compensations (/contract/v1/monthly-variable-compensations).
- Contribution groups: via Contribution Groups (/contract/v1/contribution-groups).
5. Monitoring and webhooks
Sesame HR allows you to configure webhooks to notify external systems when relevant events occur. This keeps the ERP updated in real time without the need for periodic polling. See the Webhooks section of this guide for more details.
🛠️ Need help with the integration? Our technical team can advise you on the design and implementation. Contact your Account Manager or open a support ticket. |