Skip to main content

Revel Installation Instructions

Step-by-step setup for the iPaaS.com Revel integration — credentials, subscription settings, authentication, and post-installation verification.

This article walks subscribers or their MiSP through connecting iPaaS.com to Revel, configuring authentication, reviewing the key subscription settings, and verifying that data flows correctly after installation. This initial release supports Employee and Timesheet synchronization.

Before You Begin

Before installing the Revel integration, make sure you have the following in place.

REST API access to your Revel account: Contact Revel to request REST API access. Revel provides an API Key and an API Secret for your account. Revel does not offer a self-service way to generate REST API credentials, so these must be requested rather than created in the management console.

A Revel user for record attribution: Revel records the user that created and last updated every record it stores. Decide which Revel user the integration should write records as, and note its user ID. This value is entered in iPaaS.com as the AgentId setting. It must be a valid Revel user, or writes into Revel will fail.

Your Revel site address: Revel hosts each customer on their own subdomain rather than a single shared address. Note the address you use to sign in to Revel — it takes the form https://yoursubdomain.revelup.com — as this is the value entered as the API Url setting.

For reference on Revel's API, see Revel's developer documentation.

Installation Instructions for Integration Setup

Add and enable the Revel integration from the iPaaS.com side, then create a subscription and apply its initial settings.

  1. Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.

  2. Locate and click the Revel integration tile in the Certified Integration Marketplace.

    The Revel integration tile in the iPaaS.com Certified Integration Marketplace.

  3. On the Subscription Detail page, review the integration details and click Subscribe.

    The Revel Subscription Detail page, showing the integration description and the Subscribe button.

  4. Enter a subscription name and select a version. Use a name that is relevant and unique within your company. A common convention is [Product Name] - [Environment/Purpose], for example Revel - Production.

  5. Leave Create Default Mappings selected (recommended). This pre-builds the standard mapping collections so you do not have to create every mapping by hand.

    Note: If you prefer to build all mappings from scratch yourself, clear this checkbox.

  6. On the Subscription Settings page, enter the connection details and review the throttle and concurrency controls.

    The iPaaS.com Subscription Settings page for Revel, showing the Name, Versions and Create Default Mappings fields, the AgentId, API Key, API Secret and API Url credential fields, and the throttling and concurrency fields below them.

    • API Url: Enter the base address of your own Revel site, including your subdomain — for example https://yoursubdomain.revelup.com. Revel is hosted per store, so there is no fixed iPaaS.com test or production URL to choose between; the endpoint is always your specific Revel site.

    • AgentId, API Key, API Secret: enter the values described in Authentication Configuration below.

    • API Throttle Limit: the maximum number of API requests allowed within the throttle window. A separate paired field on the page applies the same limit to data flowing in the inbound direction. Recommended values — Initial: 5, Ongoing: 500, High Volume: 500.

    • API Throttle Seconds: the length of the throttle window in seconds, with a paired inbound field alongside it. Both are pre-populated at 60.

    • Concurrent Connections and Concurrent Batch Executions: the number of simultaneous connections and batches the integration runs. Pre-populated for this integration; reduce them if you encounter rate-limit errors from Revel.

  7. Click Apply to save the subscription settings.

  8. Test the connection to confirm the credentials are valid, as described in Post-Installation Verification below.

Authentication Configuration

Revel authenticates each request with a key and secret sent together in a single header. iPaaS.com builds that header from the values you enter, so there is no separate sign-in step, token exchange, or consent screen to complete. Enter the following on the Subscription Settings page.

API Key

  • Location: Provided by Revel when you request REST API access.

  • Description: Identifies your Revel account to the API. Paired with the API Secret to authenticate every request.

API Secret

  • Location: Provided by Revel alongside the API Key.

  • Description: The secret half of the API credential. Treat it like a password and store it securely.

API Url

  • Location: Your Revel sign-in address, in the form https://yoursubdomain.revelup.com.

  • Description: The base address of your Revel site. Because Revel is hosted per store, this is your own subdomain, not a shared iPaaS.com endpoint.

AgentId

  • Location: The user ID of a valid Revel user, from your Revel user management.

  • Description: The Revel user that records created by the integration are attributed to. It is used when the integration writes employees and timesheets into Revel.

Important Notes

  • AgentId is not part of authentication. A connection can test successfully with an invalid AgentId, but any transfer that writes into Revel will then fail because Revel requires a valid user on the record. Confirm the AgentId is a real Revel user before enabling any outbound collection.

  • Credentials are requested, not self-generated. If your API Key and Secret have not yet been enabled for REST API access by Revel, the connection test fails. Request access from Revel before installing.

  • The API Url must be your own subdomain. A connection pointed at the wrong host does not authenticate. Use the same address you sign in to Revel with.

Post-Installation Verification

Connection Test

  1. On the Subscription Settings page, save the configuration and use the connection test.

  2. iPaaS.com verifies the credentials by retrieving your Revel company record. A confirmation message indicates success.

  3. If the test fails, re-check the API Url subdomain and confirm that Revel has enabled REST API access for your key and secret.

Data Sync Test

  1. From the iPaaS.com Manual Sync page, transfer a single Revel employee by entering its Revel Employee ID.

  2. Confirm the employee appears as an iPaaS.com Employee record with the expected name and email address.

  3. To verify timesheet flow, transfer a Revel timesheet entry by its Revel Timesheet Entry ID and confirm the corresponding iPaaS.com Timesheet and its child entries are created. A timesheet only transfers once its employee has been transferred and linked.

Support and Troubleshooting

For help with the iPaaS.com platform and this integration:

For questions specific to Revel's API, credentials, or account access, refer to Revel's developer documentation or contact Revel directly.

Related Documents

Related Articles
Did this answer your question?