Skip to navigation
Build an extension app

Register an extension app

View as Markdown

When you register an extension app in the Developer Console, you configure parameters that determine how the app functions as well as metadata that describes the app. These settings include:

You have two options for app registration:

  • Use a guided form-based UI: This process enables you to register an extension app by filling out fields in the Developer Console.
  • Use an app manifest file: In this process, you register the extension app by populating values in a JSON file that you upload or paste into the Developer Console app manifest editor.

Form-based and app manifest method comparison

This table shows which extension app registration method is more useful in various scenarios.

If you want toSelect this methodBecause
Register an extension app using the easiest methodForm-basedThis method presents all required fields in a user-friendly UI and guides you through the process of populating the fields.
Spend less time troubleshootingForm-basedThis method ensures that you can only supply valid values for extension app settings, and it automatically populates some values to reduce the risk of errors.
Enable non-technical users in your organization to define App Center listing detailsForm-basedThe Developer Console has a dedicated page where the description, icon, screenshots, and other App Center listing details can be defined, and it’s separate from the technical settings related to authorization and API endpoints.
Register a new extension app by copying an existing app’s detailsApp manifest fileThis method enables you to download the app manifest file for an existing extension app, modify it, and register a new extension app by uploading the modified file.
Update multiple settings via a search and replaceApp manifest fileThis method enables you to quickly replace multiple values either directly in the app manifest editor or by downloading the manifest, replacing values, and uploading the new version.
Test an extension app using a reference implementation that Docusign provides on GitHubApp manifest fileThe GitHub repos include preconfigured manifest files that require only minor modifications to work with a local copy of a reference implementation. You can upload your modified file to register a sample extension app that enables you to test with the reference implementation.

Manifest is created regardless of registration method

When you register an extension app via a form, the Developer Console saves the app details in a manifest file. You can update app details by editing this file or using the form-based UI. Similarly, extension apps registered via a manifest file can be updated through either the form-based UI or by editing the manifest file directly. See Update an extension app registration for details about how to use each method.

Prerequisites for registering an extension app

These prerequisites apply for both the form-based and app manifest file methods for registering an extension app:

  • You will need a Docusign developer account with admin privileges.
  • If your app will use external API service endpoints that don’t conform to the Docusign Action schema, you may need to set up an API proxy to translate the external API’s requests and responses to the format that Docusign expects.
  • You will need to obtain the external service, identity provider, and API proxy information that you will need to configure your extension app. This includes endpoint URLs, authorization details, and required parameters in requests to the endpoints and in the responses.

Next steps