Integrate with DocuSign

Use these recipes to create a draft envelope in your DocuSign account and retrieve the status of an existing DocuSign envelope, respectively.

Note:

These recipes are available in the Integration Store as:
  • REST — DocuSign | Create Envelope
  • REST — DocuSign | Get Envelope Status

Oracle provides these recipes as samples only. These recipes are meant only for guidance, and are not warranted to be error-free. No support is provided for these recipes.

Overview

With these recipes, you can:
  • Create a draft envelope containing a document (for example, a PDF document) in your DocuSign account. Subsequently, from your DocuSign account, you can edit this envelope and send it to the required recipients.
  • Retrieve the status of an existing envelope in your DocuSign account.
To run the DocuSign recipes, you must configure the Oracle DocuSign Connection with the details necessary to access the DocuSign application. You can then trigger the recipes through a REST request and supply the necessary request payload.
  • For the REST — DocuSign | Create Envelope recipe, you must supply the ID of the document you want to insert within a DocuSign envelope, the name of the document, and the Base64 value for the document as the request payload. The DocuSign Adapter in the recipe is subsequently invoked, and it creates a draft envelope with your document in your DocuSign account. The response containing the new envelope ID is returned to you.
  • For the REST — DocuSign | Get Envelope Status recipe, you must supply the ID of the DocuSign envelope of which you want the status as the request payload. The DocuSign Adapter in the recipe is subsequently invoked, and it fetches the status of the specified envelope. The response containing the status and the last status-change date and time is returned to you.
Integration Name Description REST Commands and Example Payloads

Create Envelope

Creates a draft envelope containing a document in your DocuSign account.

REST API Command:
POST: https://<host:port>/ic/api/integration/v1/flows/rest/ORCL-R-REST_DOCUSI_SEND_ENVELO/1.0/createdocusign
Example Request Payload:
{ "documentId" : "12345", "name" : "new", "documentBase64" : "<Base64_equivalent_of_a_PDF_file>"
}
Example Response Payload:
{
    "envelopeId": "cdf684b3-b1af-4d2a-a56e-4d3a146c5c08"
}

Get Envelope Status

Retrieves the status of an existing envelope in your DocuSign account.

REST API Command:
POST: https://<host:port>/ic/api/integration/v1/flows/rest/ORCL-R-REST_DOCUSI_GET_ENVE_STAT/1.0/envelopstatuschanges
Example Request Payload:
{ "envelopidId":"13e47618-b03f-4fac-ac4d-3fc0c9477311" }
Example Response Payload:
{
    "status": "created",
    "statuschangedatetime": "2021-04-13T13:22:20.1730000Z"
}

System and Access Requirements

  • Oracle Integration
  • DocuSign

Install, Configure, and Run the Recipes

For more information and steps to install, configure, and run recipes, see Get Started with Integration Accelerators and Recipes.

Configure the Oracle REST Connection and the Oracle DocuSign Connection present in the recipe package. You only need to configure these connections once. Both the DocuSign recipes use the same connections.

You must supply the following information when you configure these connections.

Connection Name Parameters

Oracle REST Connection

The connection parameters are already configured for you. Test and save the connection.

Oracle DocuSign Connection

Security

  • Client ID (Integrator Key): The App/Integration Key of the integration created on DocuSign.
  • Client Secret: The Secret Key of the integration created on DocuSign.
  • Scope: The list of scopes for which you want to grant permission, for example, signature extended.
  • Instance Type: The type of your DocuSign instance. This is an optional field.
  • Account ID: The API Account ID of the integration created on DocuSign. This is an optional field.

For more details, see Create a DocuSign Adapter Connection in Using the DocuSign Adapter with Oracle Integration.