---
title: "External Integration Settings"
slug: "external-integration-settings"
updated: 2025-04-02T20:56:14Z
published: 2025-04-02T20:56:14Z
canonical: "docs.processmaker.com/external-integration-settings"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.processmaker.com/llms.txt
> Use this file to discover all available pages before exploring further.

# External Integration Settings

> [!WARNING]
> Deprecation Notice
> 
> The External Integrations feature has been deprecated and is no longer available in ProcessMaker platform.

## What are External Integrations?

ProcessMaker Platform facilitates integration with a large library of third-party applications and services, including the following:

- BambooHR
- DocuSign
- GitHub
- Gmail
- Microsoft Excel
- Slack

ProcessMaker Platform integrates with the external drivers in the following manner:

- Administrators [add a supported driver from **Settings**](/v1/docs/external-integration-settings#add-a-cdata-driver) and configure authentication for that external integration.
- Process Designers see the External Integration like any other Process model object. They [add the external integration to their Process model](/v1/docs/external-integrations), and then configure it for that object.

## View External Integration Settings

Display all External Integration settings in one location. This makes it easy to manage these settings.

**Permissions**

Your user account or group membership must have the "Settings: View Settings" permission to view External Integration settings unless your user account has the **Make this user a Super Admin** setting selected.

See the [Settings](/v1/docs/permission-descriptions-for-users-and-groups#settings) permissions or ask your Administrator for assistance.

Follow these steps to view all External Integration settings to synchronize users in your organization:

1. Ensure that you are [logged on](/v1/docs/participant-basics#log-on-to-processmaker-platform) to ProcessMaker Platform.
2. Click the **Admin** option from the top menu. The **Users** page displays.
3. Click the **Settings** icon ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/771807e7-275f-4405-a3c1-6b98189ea5fc.png) from the left sidebar to view all settings.
4. From the **Settings** panel on the left, expand the **Integrations** section.
5. Select **External Integrations** to view the following details:

  - **Setting:** The **Setting** column displays the External Integrations setting name.
  - **Configuration:** The **Configuration** column displays the value of the setting and how it is configured.

![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/5bfb8839-d034-4f89-8de0-80c7460ecce2.png)

External Integrations settings to synchronize data in your organization

## Add a Driver

**Permissions**

Your user account or group membership must have the "Settings: View Settings" permission to add a driver unless your user account has the **Make this user a Super Admin** setting selected.

See the [Settings](/v1/docs/permission-descriptions-for-users-and-groups#settings) permissions or ask your Administrator for assistance.

Follow these steps to add a driver for an External Registration:

1. ​[View your External Integrations](/v1/docs/external-integration-settings#view-external-integration-settings). The **External Registrations** tab displays.
2. Click the **+Driver** button. The **Add Driver** window displays.

![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/6b70fd8e-bb50-49f8-b3f3-52fc8dcce6bd.png)
3. From the **Select a Driver** dropdown, select one of the following drivers:

  - BambooHR
  - DocuSign
  - GitHub
  - Gmail
  - Microsoft Excel
  - Slack
4. Click **Add Driver**.

## Configure an External Integration

Expand the options below to view configuration settings for each external integration.

**Configure to Connect the BambooHR Server**

Before proceeding, ensure that you have the API Key from your registered BambooHR server. For information on how to obtain this key, see [BamboHR's Getting Started with the API](https://documentation.bamboohr.com/docs/getting-started) guide.

**Permissions**

Your user account or group membership must have the "Settings: Update Settings" permission to edit External Integrations unless your user account has the **Make this user a Super Admin** setting selected.

See the [Settings](/v1/docs/permission-descriptions-for-users-and-groups#settings) permissions or ask your Administrator for assistance.

Follow these steps to connect to the BambooHR server:

1. ​[View your External Integrations](/v1/docs/external-integration-settings#view-external-integration-settings). The **External Integrations** tab displays.
2. Click the **Edit** icon ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/701a55e5-cf9f-4a7b-9f9a-55b2e1b0047d.png) next to **BambooHR** to view its settings. If you do not see **BamboHR** in the list, [see instructions on how to dd the driver](/v1/docs/external-integration-settings#add-a-cdata-driver).

![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/82538e13-6226-4f11-9f2d-23497ef2fce8.png)
3. In the **API Key** setting, enter the API Key from your registered BambooHR account. For more information on how to get the API Key, see [Authentication](https://documentation.bamboohr.com/docs/getting-started#authentication).
4. In the **Domain** setting, enter the domain from your registered BambooHR account. The domain is the text just before `.bamboohr.com` for your domain.
5. Click **Authorize**. If authorization is successful, BambooHR will be listed as authorized on the **External Integrations** page.

**Configure to Connect to the DocuSign Server**

Before proceeding, ensure that you have the client ID and client secret from your registered DocuSign driver.

Follow these steps to connect to the DocuSign server:

**Permissions**

Your user account or group membership must have the "Settings: Update Settings" permission to edit External Integrations unless your user account has the **Make this user a Super Admin** setting selected.

See the [Settings](/v1/docs/permission-descriptions-for-users-and-groups#settings) permissions or ask your Administrator for assistance.

1. ​[View your External Integrations](/v1/docs/external-integration-settings#view-external-integration-settings). The **External Integrations** tab displays.
2. Click the **Edit** icon ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/701a55e5-cf9f-4a7b-9f9a-55b2e1b0047d.png) for the **DocuSign** setting. The **DocuSign** screen displays.

![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/2ad98067-2394-466d-ad79-64a5cb04749e.png)
3. In the **Client ID** setting, enter the client ID from your registered DocuSign driver. If testing DocuSign to get the client ID, see [Enable OAuth for Connect](https://support.docusign.com/s/document-item?language=en_US&bundleId=pik1583277475390&topicId=nfg1665006528758.html&_LANG=enus).
4. In the **Client Secret** setting, enter the client secret from your registered DocuSign driver. If testing DocuSign to get client secret, see [Enable OAuth for Connect](https://support.docusign.com/s/document-item?language=en_US&bundleId=pik1583277475390&topicId=nfg1665006528758.html&_LANG=enus).
5. Use the copy icon ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/b187927e-6aa0-4ab7-98b7-cedf34f4edaf.png) to copy the URL from the **Redirect URL** setting, and then provide it to your OAuth identity provider.
6. Enable **Use Sandbox** if you are using a sandbox account.
7. Click **Authorize**. If authorization is successful, the **External Integrations** page lists DocuSign as authorized**.**

**Configure to Connect the GitHub Server**

Before proceeding, ensure that you have the client ID and client secret from your registered GitHub driver.

**Permissions**

Your user account or group membership must have the "Settings: Update Settings" permission to edit External Integrations unless your user account has the **Make this user a Super Admin** setting selected.

See the [Settings](/v1/docs/permission-descriptions-for-users-and-groups#settings) permissions or ask your Administrator for assistance.

Follow these steps to connect to the GitHub server:

1. ​[View your External Integrations](/v1/docs/external-integration-settings#view-external-integration-settings). The **External Integrations** tab displays.
2. Click the **Edit** icon ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/701a55e5-cf9f-4a7b-9f9a-55b2e1b0047d.png) for the **GitHub** setting. The **GitHub** screen displays.

![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/a6be9fab-7628-4f02-a5ac-ddfba7303105.png)
3. In the **Client ID** setting, enter the client ID from your registered GitHub driver. If testing GitHub to get the client ID, see [Creating an OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app).
4. In the **Client Secret** setting, enter the client secret from your registered GitHub driver. If testing GitHub to get the client secret, see [Creating an OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app).
5. Use the copy icon ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/b187927e-6aa0-4ab7-98b7-cedf34f4edaf.png) to copy the URL from the **Redirect URL** setting, and then provide it to your OAuth identity provider.
6. In the **Repository Name** setting, enter the GitHub repository name to restrict query results.
7. In the **User Login** setting, enter the GitHub user name to restrict query results.
8. Click **Authorize**. If authorization is successful, the **External Integrations** page lists GitHub as authorized**.**

**Configure to Connect the Gmail Server**

Before proceeding, ensure that you have the client ID and client secret from your registered Gmail driver. For information on getting the client ID and secret, see [Google's Authentication API](https://developers.google.com/identity/protocols/oauth2#1.-obtain-oauth-2.0-credentials-from-the-dynamic_data.setvar.console_name-.) guide.

**Permissions**

Your user account or group membership must have the "Settings: Update Settings" permission to edit External Integrations unless your user account has the **Make this user a Super Admin** setting selected.

See the [Settings](/v1/docs/permission-descriptions-for-users-and-groups#settings) permissions or ask your Administrator for assistance.

Follow these steps to connect to the Gmail server:

1. ​[View your External Integrations](/v1/docs/external-integration-settings#view-external-integration-settings). The **External Integrations** tab displays.
2. Click the **Edit** icon ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/701a55e5-cf9f-4a7b-9f9a-55b2e1b0047d.png) next to **Gmail** to view its settings. If you do not see **Gmail** in the list, [see instructions on how to add the driver](/v1/docs/external-integration-settings#add-a-cdata-driver).

![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/f0811010-4423-457e-95b2-4756e3b12c64.png)
3. In the **Client ID** setting, enter the client ID from your registered Gmail driver. For more information about how to get the client ID, see [Obtain OAuth 2.0 credentials from the Google API Console](https://developers.google.com/identity/protocols/oauth2#1.-obtain-oauth-2.0-credentials-from-the-dynamic_data.setvar.console_name-.).
4. In the **Client Secret** setting, enter the client secret from your registered Gmail driver. For more information about how to get the client secret, see [Obtain OAuth 2.0 credentials from the Google API Console](https://developers.google.com/identity/protocols/oauth2#1.-obtain-oauth-2.0-credentials-from-the-dynamic_data.setvar.console_name-.).
5. Use the copy icon ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/bbc2826c-a64b-4f47-be00-f14d2d447130.png) to copy the URL from the **Redirect URL** setting, and then provide it to your OAuth identity provider.
6. Click **Authorize**. If authorization is successful, the **External Integrations** page lists Gmail as authorized**.**

**Configure to Connect the Microsoft Excel Server**

Before proceeding, ensure that you have the client ID and client secret from your registered Microsoft Excel driver.

**Permissions**

Your user account or group membership must have the "Settings: Update Settings" permission to edit External Integrations unless your user account has the **Make this user a Super Admin** setting selected.

See the [Settings](/v1/docs/permission-descriptions-for-users-and-groups#settings) permissions or ask your Administrator for assistance.

Follow these steps to connect to the Microsoft Excel server:

1. ​[View your External Integrations](/v1/docs/external-integration-settings#view-external-integration-settings). The **External Integrations** tab displays.
2. Click the **Edit** icon ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/701a55e5-cf9f-4a7b-9f9a-55b2e1b0047d.png) for the **Microsoft Excel** setting. The **Microsoft Excel** screen displays.

![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/bc315662-d9ba-43ae-bad8-7b7f0cb0a009.png)
3. In the **Client ID** setting, enter the client ID from your registered Microsoft Excel driver. If testing Microsoft Excel to get the client ID, see [Add a client ID and client secret](https://learn.microsoft.com/en-us/partner-center/marketplace/create-or-update-client-ids-and-secrets#add-a-client-id-and-client-secret).
4. In the **Client Secret** setting, enter the client secret from your registered Microsoft Excel driver. If testing Microsoft Excel to get the client secret, see [Add a client ID and client secret](https://learn.microsoft.com/en-us/partner-center/marketplace/create-or-update-client-ids-and-secrets#add-a-client-id-and-client-secret).
5. Use the copy icon ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/b187927e-6aa0-4ab7-98b7-cedf34f4edaf.png) to copy the URL from the **Redirect URL** setting, and then provide it to your OAuth identity provider.
6. From the **Connection Type** dropdown, select the service for storing and retrieving Microsoft Excel files such as Amazon S3, Azure Blog Store, Box, Dropbox, Google Cloud Storage, Google Drive, OneDrive, or SharePoint REST.
7. In the **URI** setting, enter the Uniform Resource Identifier (URI) for the Microsoft Excel resource location.
8. Click **Authorize**. If authorization is successful, the **External Integrations** page lists Microsoft Excel as authorized**.**

**Configure to Connect the Slack Server**

Before proceeding, ensure that you have the client ID and client secret from your registered Slack driver.

**Permissions**

Your user account or group membership must have the "Settings: Update Settings" permission to edit External Integrations unless your user account has the **Make this user a Super Admin** setting selected.

See the [Settings](/v1/docs/permission-descriptions-for-users-and-groups#settings) permissions or ask your Administrator for assistance.

Follow these steps to connect to the Slack server:

1. ​[View your External Integrations](/v1/docs/external-integration-settings#view-external-integration-settings). The **External Integrations** tab displays.
2. Click the **Edit** icon ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/701a55e5-cf9f-4a7b-9f9a-55b2e1b0047d.png) for the **Slack** setting. The **Slack** screen displays.

![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/ef19adaa-8b69-4329-afed-d907f0c527aa.png)
3. In the **Client ID** setting, enter the client ID from your registered Slack driver. If testing Slack to get the client ID, see [Creating a Slack App](https://api.slack.com/tutorials/slack-apps-and-postman).
4. In the **Client Secret** setting, enter the client secret from your registered Slack driver. If testing Slack to get the client secret, see [Creating a Slack App](https://api.slack.com/tutorials/slack-apps-and-postman).
5. Use the copy icon ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/b187927e-6aa0-4ab7-98b7-cedf34f4edaf.png) to copy the URL from the **Redirect URL** setting, and then provide it to your OAuth identity provider.
6. Click **Authorize**. If authorization is successful, the **External Integrations** page lists Slack as authorized**.**