Skip to main content

Creating an integration

Overview​

Reworkly APIs are openly available APIs which can be called by any developer that knows how to call REST-based APIs. Access to these APIs is controlled by apps, with specific permissions and protected by access tokens.

tip

Only Company Admins of a Reworkly can create custom integration and generate access tokens.

Create an Integration​

To create an integration, log in as an Admin who has the permission to change company settings and configure integrations.

Once you're logged in you can complete the following steps to create an integration:

info
  1. In the Admin Panel, navigate to the Integrations sction.
  2. Click on the Create Custom Integration button.
  3. In the dialog, enter a Name and a Description for your integration.
  4. Click the Create button.

Once you have created the integration, you can proceed to configure it.

Basic Configuration​

In the Integrations section of the Admin Panel, click the name of the integration to be configured. These are the fields you may find in the Integration details screen.

  • Name: You can modify the Name of the integration
  • Description: You can modify the Description of the integration
  • Logo: You can modify the Logo of the integration
  • Enabled: You can enable or disable your integration. If it's disabled, the integration will not be able to make any API request.
  • Client ID: The Client ID is a public identifier for the integration.
  • Client Secret: The Client Secret is a secret known only to the integration and the authorization server.
  • Last API request: You can view the last day that the integration made an API request and the number of requests made in the last seven days.

Next: Grant Permissions​

Each custom integration can be granted its own set of permissions to control the level of functionality available to it on the REST API.

Next →