Skip to main content

Adobe Acrobat Sign Connector

Adobe Acrobat Sign Adobe Acrobat Sign is an e-signature management solution. Use the Adobe Acrobat Sign component to send, sign, track, and manage the signature process.

Connections

OAuth 2.0

OAuth 2.0 flow

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
Authorize URLThe OAuth 2.0 Authorization URL for Acrobat Sign with the correct region/shard (this can be found in the URL when you are logged into the Adobe Sign web app). For example, if the URL is https://secure.na3.adobesign.com, the authorize URL would be 'https://secure.na3.adobesign.com/public/oauth/v2'https://secure.na3.adobesign.com/public/oauth/v2
Token URLThe OAuth 2.0 Token URL for Acrobat Sign with the correct region/shard (this can be found in the URL when you are logged into the Adobe Sign web app). For example, if the URL is https://secure.na3.adobesign.com, the token URL would be 'https://secure.na3.adobesign.com/oauth/v2/token)https://secure.na3.adobesign.com/oauth/v2/token
Refresh URLThe OAuth 2.0 Refresh URL for Acrobat Sign with the correct region/shard (this can be found in the URL when you are logged into the Adobe Sign web app). For example, if the URL is https://secure.na3.adobesign.com, the token URL would be 'https://secure.na3.adobesign.com/oauth/v2/refresh)https://secure.na3.adobesign.com/oauth/v2/refresh
ScopesSpace separated OAuth 2.0 permission scopes for Acrobat Sign. Add scope modifiers using colons. https://opensource.adobe.com/acrobat-sign/developer_guide/gstarted.html#configure-scopesuser_read:account user_write:self agreement_read:group
Client IDClient Identifier of your Acrobat Sign App (shown as Application ID inside Acrobat Sign)
Client SecretClient Secret of your Acrobat Sign App

Triggers

Webhook

Receive and validate webhook requests from Adobe Sign for webhooks you configure.

InputCommentsDefault
Connection
Perform Strict ValidationSet to true if you need to perform strict validation on each webhook notification.false

Actions

Create Account

Creates an Acrobat Sign account under the partner channel.

InputCommentsDefault
Connection
Account TypeThe type of account to be created.
Country CodeThe country code of the account.
External IDCase-sensitive External ID for which you would like to retrieve agreement information. ExternalId is passed in the call to the agreement creation API. (Note: the externalId value is visible to all participants through the API, so should not be used to contain a sensitive token)
LocaleThe locale of the user.
Trial Duration DaysAccount trial duration (in days).
EmailThe email address of the user to be created.
First NameThe first name of the user.
Last NameThe last name of the user.
PhoneThe phone number of the user.
TitleThe job title of the user.
Number of SeatsThe number of seats.
CompanyThe company of the user.
Debug RequestEnabling this flag will log out the current request.false

Create Agreement

Creates an agreement. Sends it out for signatures and returns the agreementId in the response to the client.

InputCommentsDefault
Connection
Transient Document IDID for a transient document that will be added to the agreement.
Agreement NameName of the Agreement that will be used to identify it.
Participant Set Info RoleRole assumed by all participants in this set (signer, approver, etc.)
Participant Member Info EmailEmail address of the participant.
Signature TypeThe type of signature you would like to request - written or e-signature.
Agreement StateState of the agreement.
Debug RequestEnabling this flag will log out the current request.false

Create Group

Creates a new group in an account.

InputCommentsDefault
Connection
Group NameThe name of the group.
CreatedDate of creation of the group. Format would be yyyy-MM-dd'T'HH:mm:ssZ
Is Default Grouptrue if the group is default group.
Debug RequestEnabling this flag will log out the current request.false

Create Transient Document

Uploads a document and obtains the document's ID.

InputCommentsDefault
Connection
FileThe file part of the multipart request for document upload. You can upload only one file at a time.
Mime TypeThe mime type of the document being uploaded. If not specified here then mime type is picked up from the file object. If mime type is not present there either then mime type is inferred from the file extension.
File NameA name for the document being uploaded. Maximum number of characters in the name is restricted to 255.
Debug RequestEnabling this flag will log out the current request.false

Create User

Creates a new user in the Acrobat Sign system.

InputCommentsDefault
Connection
EmailThe email address of the user to be created.
Account Admintrue if the user is account admin.false
CompanyThe company of the user.
First NameThe first name of the user.
Last NameThe last name of the user.
InitialsThe initials of the user.
LocaleThe locale of the user.
PhoneThe phone number of the user.
TitleThe job title of the user.
Account IDThe account id of the user.
Debug RequestEnabling this flag will log out the current request.false

Create Webhook

Creates a webhook.

InputCommentsDefault
Connection
Webhook Subscription EventsThe list of events for which the webhook subscription is being made.
ScopeScope of the webhook
Webhook NameThe name of the webhook.
Webhook URLThe URL to which the webhook payload is to be delivered.
Application Display NameThe name of the application through which the webhook is created
Application NameThe name of the application through which the webhook is created
Problem Notification EmailsThe list of email addresses to which the webhook problem is to be notified.
Resource IDId of the resource type for which you want to create webhook. Provide agreementId if webhook needs to be created for an agreement. Similarly, widgetId if webhook needs to be created for a web form,megaSignId if webhook needs to be created for a bulk send and libraryDocumentId if webhook needs to be created for a library document. NOTE: Need to specify only if scope is 'RESOURCE'.
Webhook Resource TypeThe type of resource being accessed. (Note: need to specify this only if scope is Resource).
Webhook Agreement Conditional ParametersConditions which webhook creator can specify for the payload while creating or updating a webhook.
Webhook Library Documents Conditional ParametersConditions which webhook creator can specify for the payload while creating or updating a webhook.
Webhook MegaSign Conditional ParametersConditions which webhook creator can specify for the payload while creating or updating a webhook.
Webhook Widget Conditional ParametersConditions which webhook creator can specify for the payload while creating or updating a webhook.
Debug RequestEnabling this flag will log out the current request.false

Delete Agreement Documents

Deletes all the documents for an agreement.

InputCommentsDefault
Connection
Agreement IDThe agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. If provided
Debug RequestEnabling this flag will log out the current request.false

Delete Group

Delete an existing group.

InputCommentsDefault
Connection
Group IDThe unique identifier of the group.
Debug RequestEnabling this flag will log out the current request.false

Delete Webhook

Deletes a webhook.

InputCommentsDefault
Connection
Webhook IDThe webhook identifier, as returned by the Adobe Sign Webhook API.
Debug RequestEnabling this flag will log out the current request.false

Download Agreement PDF

Downloads the PDF associated with an agreement.

InputCommentsDefault
Connection
Agreement IDThe agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. If provided
Debug RequestEnabling this flag will log out the current request.false

Get Account

Retrieves the information for an account.

InputCommentsDefault
Connection
Account IDThe account id of the user.
Debug RequestEnabling this flag will log out the current request.false

Get Agreement

Retrieves the current status of an agreement.

InputCommentsDefault
Connection
Agreement IDThe agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. If provided
Debug RequestEnabling this flag will log out the current request.false

Get Group

Retrieves detailed information about the group.

InputCommentsDefault
Connection
Group IDThe unique identifier of the group.
Debug RequestEnabling this flag will log out the current request.false

Get User

Retrieves detailed information about the user in the caller account.

InputCommentsDefault
Connection
Debug RequestEnabling this flag will log out the current request.false
User IDThe user identifier, as returned by the user creation API or retrieved from the API to fetch users. If provided

Get Webhook

Retrieves the details of a webhook.

InputCommentsDefault
Connection
Webhook IDThe webhook identifier, as returned by the Adobe Sign Webhook API.
Debug RequestEnabling this flag will log out the current request.false

List Agreements

Retrieves agreements for the user.

InputCommentsDefault
Connection
CursorUsed to navigate through pagination. If not provided, it will default to the first page.
Page SizeThe number of results to return per page. If not provided, it is decided by your application settings.
External IDCase-sensitive External ID for which you would like to retrieve agreement information. ExternalId is passed in the call to the agreement creation API. (Note: the externalId value is visible to all participants through the API, so should not be used to contain a sensitive token)
Group IDThe group identifier, as returned by the group creation API or retrieved from the API to fetch groups. If provided
Show Hidden AgreementsA query parameter to fetch all the hidden agreements along with the visible agreements. Default value is false.false
Debug RequestEnabling this flag will log out the current request.false

List Group Events

Retrieves all events for group

InputCommentsDefault
Connection
Group IDThe unique identifier of the group.
CursorUsed to navigate through pagination. If not provided, it will default to the first page.
Page SizeThe number of results to return per page. If not provided, it is decided by your application settings.
Debug RequestEnabling this flag will log out the current request.false

List Groups

Retrieve a list of groups in the Adobe Sign account.

InputCommentsDefault
Connection
CursorUsed to navigate through pagination. If not provided, it will default to the first page.
Page SizeThe number of results to return per page. If not provided, it is decided by your application settings.
Debug RequestEnabling this flag will log out the current request.false

List Group Users

Retrieves all the users in a group.

InputCommentsDefault
Connection
Group IDThe unique identifier of the group.
CursorUsed to navigate through pagination. If not provided, it will default to the first page.
Page SizeThe number of results to return per page. If not provided, it is decided by your application settings.
Debug RequestEnabling this flag will log out the current request.false

List Users

Retrieves all the users in an account.

InputCommentsDefault
Connection
CursorUsed to navigate through pagination. If not provided, it will default to the first page.
Page SizeThe number of results to return per page. If not provided, it is decided by your application settings.
Debug RequestEnabling this flag will log out the current request.false

List Webhooks

Retrieves webhooks for a user.

InputCommentsDefault
Connection
Show Inactive WebhooksA query parameter to fetch all the inactive webhooks along with theactive webhooks. Default value is false.false
ScopeFilter for webhooks with a specific scope.
Webhook Resource TypeThe type of resource being accessed. (Note: need to specify this only if scope is Resource).
CursorUsed to navigate through pagination. If not provided, it will default to the first page.
Page SizeThe number of results to return per page. If not provided, it is decided by your application settings.
Debug RequestEnabling this flag will log out the current request.false

Raw Request

Send raw HTTP request to Adobe Acrobat Sign

InputCommentsDefault
Connection
URLInput the path only (/agreements), The base URL is already included. For example, in order to send a agreements request, only /agreements is entered in this field.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Debug RequestEnabling this flag will log out the current request.false
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.false
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false

Search Resources

Retrieves, searches, filters and sorts agreements for the user

InputCommentsDefault
Connection
Ownership ScopeOwnership scope of the agreement documents to include in this search request. Default is 'OWNED'.
External IDA filter against case-sensitive external id for which you would like to retrieve agreement asset information. External id is passedin the call to the agreement asset creation API. Supply them in acomma-separated manner.
Group IDA filter against group identifier(s), as returned by the group creation API or retrieved from the API to fetch groups.
Asset ID(s)A filter against case-sensitive agreement asset id for which you would like to retrieve the information.
Library Document IDA filter against case-sensitive library document id that was usedto create an agreement. This filter will only apply for the sender of theagreement since signers don't have the knowledge of how the agreement wascreated. Also, this filter only applies to library documents with type DOCUMENT but not FORM_FIELD_LAYER
Page SizeThe number of results to return per page. If not provided, it is decided by your application settings.
Parent IDA filter against case-sensitive parent id for which you would like to retrieve agreement asset information.
Participant EmailA filter against participant emails for which you would like to retrieve agreement asset information.
Queryable FieldsA list of field names against which string query specified in the 'query' field above is executed. For more information, please refer here: https://helpx.adobe.com/sign/using/adobesign-search-users-agreements.html#NamePrefix
RoleA filter against the roles the user has on agreement assets
Sort By FieldDefines the field by which the results will be ordered
Sort OrderSets the direction of the order
Start Index0-based first row (offset) of the search results to return. The value must be greater than or equal to 0 and less than 10000. If not provided, the default value is 0 and returns results from the very first row, without offset
StatusA filter against the detailed status of the agreement asset.PLEASE note that PARTIAL and DRAFT agreements are not supported for search
Sub TypesA filter against the agreement asset sub types. Only agreement assets with type LIBRARY_TEMPLATE currently have this field populated.
TypeA filter against the agreement asset type.
User IDA filter against the user for account sharing. (Comma-separated)
VisibilityA filter indicating the visibility level of agreements that get returned in the response.
Workflow IDA filter against case-sensitive workflow id for which you wouldlike to retrieve agreement asset information. Workflow id is passed in the call to the agreement asset creation API.
QueryThis field provides text search capibility against termsin the field values of agreements that are visibile to the usermaking the request. To find more about how text searching works please refer here: https://helpx.adobe.com/sign/using/adobesign-search-users-agreements.html#HowSearchWorks
Created Greater Than DateThe maximum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.Range terms can be defined as less-than/greater-than or min/max.If terms are mixed the JSON will be considered malformed.
Expiration Greater Than DateThe maximum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.Range terms can be defined as less-than/greater-than or min/max.If terms are mixed the JSON will be considered malformed.
Modified Greater Than DateThe minimum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.
Created Less Than DateThe maximum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.Range terms can be defined as less-than/greater-than or min/max.If terms are mixed the JSON will be considered malformed.
Expiration Less Than DateThe maximum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.Range terms can be defined as less-than/greater-than or min/max.If terms are mixed the JSON will be considered malformed.
Modified Less Than DateThe minimum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.
Created Max DateThe maximum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.Range terms can be defined as less-than/greater-than or min/max.If terms are mixed the JSON will be considered malformed.
Expiration Max DateThe maximum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.Range terms can be defined as less-than/greater-than or min/max.If terms are mixed the JSON will be considered malformed.
Modified Max DateThe minimum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.
Created Min DateThe minimum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.Range terms can be defined as less-than/greater-than or min/max.
Expiration Min DateThe maximum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.Range terms can be defined as less-than/greater-than or min/max.If terms are mixed the JSON will be considered malformed.
Modified Min DateThe minimum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.
Debug RequestEnabling this flag will log out the current request.false

Update Agreement

Updates the agreement in draft state, or update the expiration time on an existing agreement that is already out for signature.

InputCommentsDefault
Connection
Transient Document IDID for a transient document that will be added to the agreement.
Participant Set Info RoleRole assumed by all participants in this set (signer, approver, etc.)
Signature TypeThe type of signature you would like to request - written or e-signature.
Agreement StateState of the agreement.
Expiration DateA range filter against the agreement expiration date.Format would be date-time with an offset from UTC/Greenwich in theISO-8601 format, such as 2007-12-03T10:15:30+01:00.Range terms can be defined as less-than/greater-than or min/max.
Agreement IDThe agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. If provided
Debug RequestEnabling this flag will log out the current request.false

Update Group

Update an existing group.

InputCommentsDefault
Connection
Group IDThe unique identifier of the group.
Group NameThe name of the group.
CreatedDate of creation of the group. Format would be yyyy-MM-dd'T'HH:mm:ssZ
Is Default Grouptrue if the group is default group.
Debug RequestEnabling this flag will log out the current request.false

Update User

Update a user in the Acrobat Sign system.

InputCommentsDefault
Connection
EmailThe email address of the user to be created.
CompanyThe company of the user.
First NameThe first name of the user.
Last NameThe last name of the user.
InitialsThe initials of the user.
LocaleThe locale of the user.
PhoneThe phone number of the user.
TitleThe job title of the user.
User IDThe user identifier, as returned by the user creation API or retrieved from the API to fetch users. If provided
StatusStatus of the user.
Debug RequestEnabling this flag will log out the current request.false

Update Webhook

Updates a webhook

InputCommentsDefault
Connection
Webhook Subscription EventsThe list of events for which the webhook subscription is being made.
ScopeScope of the webhook
Webhook NameThe name of the webhook.
Webhook URLThe URL to which the webhook payload is to be delivered.
Application Display NameThe name of the application through which the webhook is created
Application NameThe name of the application through which the webhook is created
Problem Notification EmailsThe list of email addresses to which the webhook problem is to be notified.
Webhook IDThe webhook identifier, as returned by the Adobe Sign Webhook API.
Webhook Agreement Conditional ParametersConditions which webhook creator can specify for the payload while creating or updating a webhook.
Webhook Library Documents Conditional ParametersConditions which webhook creator can specify for the payload while creating or updating a webhook.
Webhook MegaSign Conditional ParametersConditions which webhook creator can specify for the payload while creating or updating a webhook.
Webhook Widget Conditional ParametersConditions which webhook creator can specify for the payload while creating or updating a webhook.
Debug RequestEnabling this flag will log out the current request.false