Skip to main content

Revel API Endpoints

The Revel REST API endpoints the iPaaS.com integration uses for employee and timesheet synchronization, grouped by resource.

This article lists the Revel API endpoints the iPaaS.com integration uses for employee and timesheet synchronization. It is a reference for firewall allow-listing, API access configuration, troubleshooting, and understanding how data moves between iPaaS.com and Revel. This initial release covers the Employee and Timesheet resources.

Areas covered: Employee · Employee Role Establishment · Timesheet Entry · Connection

API Endpoints Intro

Revel exposes a REST API. Each request and response body is JSON.

Revel hosts every customer on their own subdomain, so the base address is specific to your account rather than a shared host. It takes the form:

https://yoursubdomain.revelup.com

Throughout this article, [Base URL] stands for your own Revel address — for example, https://acmerestaurants.revelup.com. There is no separate sandbox or production host to choose between; the base address is always your Revel site. Substitute your subdomain wherever [Base URL] appears.

Employee Endpoints

The integration reads employees from Revel when synchronizing them into iPaaS.com, and creates or updates employees in Revel when synchronizing in the other direction.

List Employees (GET)

[Base URL]/resources/Employee/

Retrieves employees from Revel. A filter may be supplied as a query string to narrow the result, and results are returned in pages (see Pagination below).

Get an Employee by Id (GET)

[Base URL]/resources/Employee/{id}

Retrieves a single employee by their Revel employee ID.

Create an Employee (POST)

[Base URL]/resources/Employee/

Creates a new employee in Revel.

Update an Employee (PATCH)

[Base URL]/resources/Employee/{id}

Updates selected fields on an existing employee, leaving unspecified fields unchanged.

Replace an Employee (PUT)

[Base URL]/resources/Employee/{id}

Replaces an existing employee record by ID.

Employee Role Establishment Endpoints

An employee's establishment, role, and hourly wage are held on a separate Revel record rather than on the employee. When those values are supplied during an employee transfer, the integration reads and writes this record as part of the same operation.

List Employee Role Establishments (GET)

[Base URL]/resources/EmployeeRoleEstablishment/

Retrieves role and establishment assignments, filtered to a specific employee and establishment.

Create an Employee Role Establishment (POST)

[Base URL]/resources/EmployeeRoleEstablishment/

Creates a new role, establishment, and wage assignment for an employee.

Update an Employee Role Establishment (PUT)

[Base URL]/resources/EmployeeRoleEstablishment/{id}

Updates an existing role, establishment, and wage assignment.

Timesheet Entry Endpoints

The integration reads timesheet entries from Revel when synchronizing them into iPaaS.com, and creates or updates them in Revel when synchronizing in the other direction. In Revel, both a worked-time shift and its break are timesheet entries managed through the same endpoints.

List Timesheet Entries (GET)

[Base URL]/resources/TimeSheetEntry/

Retrieves timesheet entries from Revel. A filter may be supplied as a query string to narrow the result, and results are returned in pages (see Pagination below).

Get a Timesheet Entry by Id (GET)

[Base URL]/resources/TimeSheetEntry/{id}

Retrieves a single timesheet entry by its Revel timesheet entry ID.

Create a Timesheet Entry (POST)

[Base URL]/resources/TimeSheetEntry/

Creates a new timesheet entry in Revel.

Update a Timesheet Entry (PATCH)

[Base URL]/resources/TimeSheetEntry/{id}

Updates selected fields on an existing timesheet entry, leaving unspecified fields unchanged.

Replace a Timesheet Entry (PUT)

[Base URL]/resources/TimeSheetEntry/{id}

Replaces an existing timesheet entry by ID.

Connection Endpoints

Get Company (GET)

[Base URL]/enterprise/Company/

Retrieves your Revel company record. The integration calls this to verify the connection when you test your credentials; a successful response confirms that the API Url, API Key, and API Secret are valid.

Authentication

Revel authenticates every request with a single header that carries your API Key and API Secret together, separated by a colon:

API-AUTHENTICATION: your-api-key:your-api-secret

iPaaS.com constructs this header from the credentials you enter in the subscription settings, so there is no separate authorization or token endpoint to call, and no OAuth flow to complete. Every request to the endpoints above carries this header. See the Revel Connections and Settings article for how to obtain and enter these credentials.

Pagination

List endpoints return results in pages. Revel accepts a limit parameter for the number of records per page and an offset parameter for where the page begins, supplied as query-string values on the request. The integration reads successive pages automatically when retrieving records, so no subscriber action is required to page through a large result set.

Rate Limits

Revel does not publish a specific request-per-second rate or a numeric daily call figure. Revel does enforce a daily call allowance, and requests that exceed it are rejected until the allowance resets. When that happens, the rejection appears in Dashboard / Integration Monitoring / Error Logs. Because the published limit is unspecified, stagger large transfers rather than running several intensive jobs at the same time.

Related Documents

External References

Did this answer your question?