Microapps

Adobe Sign connector specifications

Deploy the AdobeSign integration to quickly and securely make every agreement and approval digital.

Version Details

This Adobe Sign integration and its microapps support Adobe Sign REST APIs Version 6.

Endpoints

POST

https://{HostName}.com/public/oauth https://{HostName}.com/oauth/token

/api/rest/v6/libraryDocuments/${actionParameters.libraryDocumentId}/views
/api/rest/v6/agreements/${actionParameters.agreementId}/views
/api/rest/v6/agreements
/api/rest/v6/agreements/${actionParameters.agreementId}/members/share
/api/rest/v6/transientDocuments

GET

/api/rest/v6/groups/${integrationParameters.GroupId}/users?pageSize=${PAGE_SZIE}
/api/rest/v6/agreements?pageSize=${PAGE_SZIE}
/api/rest/v6/libraryDocuments?pageSize=${PAGE_SZIE}
/api/rest/v6/agreements/${agreementId}/members

PUT

/api/rest/v6/agreements/${actionParameters.agreementId}/state

Service Actions

  • ShareAgreement - Share an agreement with other recipients.
  • CancelAgreement - Sender of an agreement can cancel the agreement.
  • sendAgreement - Send agreements to other recipients.
  • agreementView - Sign the agreement from Citrix Workspace.
  • libraryDocumentView - Edit a template agreement from workspace.

Key Entities

The following are the main business entities that this connector addresses:

  • Users
  • Agreements
    • Agreement Details
    • Agreement Views
  • Library Document
    • Library View
  • Template Types

Entities with Attributes

The following is a full list of entities and their attributes:

users

  • id: STRING
  • email: STRING
  • company: STRING
  • firstname: STRING
  • lastname: STRING
  • last_modified: TIMESTAMP

agreementdetails

  • agreement_id: STRING
  • participant_email: STRING, FK(users.email)
  • participent_id: STRING
  • participent_role: STRING
  • participent_status: STRING
  • sender_company: STRING
  • sender_email: STRING
  • sender_name: STRING
  • userid: STRING
  • last_modified: TIMESTAMP
  • status: STRING
  • createddate: TIMESTAMP
  • agreement_name: STRING

agreements

  • id: STRING, FK(agreementdetails.agreement_id)
  • displaydate: TIMESTAMP
  • esign: BOOLEAN
  • type: STRING
  • name: STRING
  • groupid: STRING
  • userid: STRING
  • latestversionid: STRING
  • status: STRING
  • hidden: BOOLEAN
  • last_modified: TIMESTAMP

templatetypes

  • templatetype: STRING
  • parentid: STRING
  • uniqueid: STRING
  • last_modified: TIMESTAMP

librarydocuments

  • id: STRING
  • name: STRING
  • creatoremail: STRING
  • owneremail: STRING
  • modifieddate: TIMESTAMP
  • sharingmode: STRING
  • groupid: STRING
  • status: STRING
  • hidden: BOOLEAN
  • last_modified: TIMESTAMP

agreementviews

  • agreement_id: STRING
  • embeddedcode: STRING
  • expiration: TIMESTAMP
  • url: STRING
  • name: STRING
  • iscurrent: BOOLEAN
  • email: STRING
  • last_modified: TIMESTAMP

librarydocumentviews

  • librarydocumentid: STRING
  • embeddedcode: STRING
  • url: STRING
  • name: STRING
  • iscurrent: BOOLEAN
  • email: STRING
  • last_modified: TIMESTAMP
Adobe Sign connector specifications