Organization-Level Connect | Docusign

Organization-Level Connect (org level Connect) enables you, as an organization admin or developer, to set and manage Connect configurations for the accounts in your organization, rather than individually.

You can create and manage Connect configurations at the organization level. An organization-level configuration is applied as a default for every account that is part of your organization, or for selected users or groups.
The data from your organization’s account-level Connect configurations is aggregated and displayed through the organization’s Connect Dashboard.
Organization-Level Connect exposes a set of API endpoints through the Admin API that enable you to create and manage your Organization-Level Connect configurations and data programmatically. This includes HMAC verification.

When to use Organization-Level Connect

Large organizations can grow to contain hundreds of accounts and thousands of Connect configurations. Without org level Connect, these configurations are very difficult to manage and troubleshoot. If one Connect configuration fails, for example, documents may not be sent, and required signatures may not be obtained. As an admin or developer, it could be necessary to check each account and configuration to identify and fix errors.

Organization-Level Connect is designed to fix these problems. It enables large organizations to manage all of their accounts and Connect configurations from a centralized location and provides data on all of your organization’s Connect configurations in a single, filterable dashboard. Use cases include:

Managing security settings for Connect configurations across multiple Docusign accounts.
Quickly identifying a specific account or configuration that is experiencing a Connect failure.
Consolidating hundreds of configurations into a single Organization-Level Connect configuration.

Administrator roles for Organization-Level Connect

Actions in Organization-Level Connect can be delegated from organization admins to other roles with more limited permissions:

Organization Administrators and Account Administrators have full access to organization-level settings and any account in the org (of which they are also admins). Org admins can create new Organization-Level Connect configs.
Organization-Only Administrators function solely as an Organizational Administrators without account-level privileges. They oversee org-level configurations and can only view the configuration and the traffic flowing through it. All configuration actions are inactive.
Delegated Organization Administrators may allocate access to Connect at the organization level. The tiers of access are:
Edit: Users can create, view, and make changes to Organization-Level Connect settings. This includes account-level Connect configurations for accounts to which they have access.
View: Users can view but not alter the Organization-Level Connect settings for an administrative area.

None: Users can view and edit settings only for the Connect accounts for which their user ID has administrator privileges.

How to use Organization-Level Connect

You can create Organization-Level Connect configurations through the organization admin UI or programmatically using the Docusign Admin API. See Organization-Level Connect for documentation focused on using the admin UI.

Organization-level Connect configurations work exactly the same as account level Connect configurations, with the following differences:

Settings defined by an organization-level configuration can be overridden by individual account-level configurations. If a setting is defined by both an org- and account-level configuration and their values are different, the account-level setting will be used.
Organization-Level Connect configurations support only the Connect 2.0 (JSON/SIM) experience. The supported security options are HMAC, TLS, and OAuth. Basic Authentication is not supported.

Enable log and require acknowledgement (auto-retry) are auto-enabled for organization-level configurations. Data format and delivery mode are not supported.

Enable Organization-Level Connect

Enable Organization-Level Connect by selecting Enable next to Allow Organization Connect on the Features page.

An image showing the organization management UI where you can enable organization connect.

Create an Organization-Level Connect configuration

To create an Organization-Level Connect configuration using the UI:

From the Organization view, in the sidebar under INTEGRATIONS, select Connect (Webhooks).
At the top right, select Add Organization Configuration > Custom. The Add Organization Configuration window displays.
Choose the settings for your configuration, then select Add Configuration to create it.

To create an Organization-Level Connect configuration using the API:

Obtain an access token using one of our OAuth2.0 grant types. Make sure that you request all of the Docusign Admin scopes that you may need, including these scopes:
- connect_org_config_read_api
- connect_org_config_write_api
- connect_org_oauth_read_api
- connect_org_oauth_write_api
- connect_org_hmac_read_api
- connect_org_hmac_write_api

Call the /v2/organizations/{organizationId}/connect endpoint using your access token and providing the JSON definition of the Organization-Level Connect configuration to create.

{
    "configurationType": "custom",
    "urlToPublishTo": "https://webhook.site/",
    "name": "sim",
    "allowEnvelopePublish": "true",
    "enableLog": "true",
    "requiresAcknowledgement": "true",
    "signMessageWithX509Certificate": "false",
    "IncludeHMAC":"true",
    "IncludeOAuth":"true",
    "integratorManaged":"true",
    "deliveryMode": "SIM",
    "events": ["envelope-sent"],
    "eventData":{
    "version": "restv2.1",
    "includeData":  ["documents"] },
    "allUsers": "true"
}

Organization Connect Dashboard

You can access the Organization Connect Dashboard by opening your organization admin page, scrolling to and selecting Connect (Webhooks), then selecting the Dashboard tab.

The organization Connect dashboard functions just like the standard Connect Dashboard, but it also aggregates and displays the data from all of the accounts in your organization, rather than just for a single account.

You can filter the displayed data by account or display the data for all accounts.
The Connect events view, beneath the event graph, also displays the account associated with each recorded event.

An image of the organization Connect dashboard, showing aggregated events for multiple account level Connect configurations.

Next steps

Learn more about Docusign Connect
See details about how to use the Connect Dashboard