Skip to main content

Adobe Acrobat Sign Component

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

Component key: adobe-acrobat-sign · Changelog ↓

Description​

Adobe Acrobat Sign is an e-signature management solution.

Use the Adobe Acrobat Sign component to send, sign, track, and manage the signature process.

API Documentation​

This component was built using the Adobe Sign REST API v6.

Connections​

OAuth 2.0​

key: oauth

To configure OAuth for Sign, begin by creating an App:

  1. Log in to Acrobat Sign.
  2. Select API from the top menu. If you do not see the API link, select Account
  3. Select API Applications.
  4. Select the Create (+) icon at the top right of the table and provide details about your app.
  5. Choose a domain based on the intended use:
  6. CUSTOMER: Apps that only access your account or are used for internal use and testing.
  7. PARTNER: Select this type if you're developing an application for other users and your app needs access to other Acrobat Sign accounts. Note: PARTNER applications must be certified to have full access to other accounts.

To Retrieve the OAuth Client ID and Secret:

  1. In the API Applications menu, select the application.
  2. Click Configure OAuth for the Application link to configure your OAuth integration.
  3. For the redirect URI enter https://oauth2.prismatic.io/callback.
  4. check the boxes for the necessary scopes needed with the modifier set to account for the integration and save.
  5. in the API Applications menu, select the application and select View / Edit.
  6. Enter the Application ID/Client ID and Client Secret Values into the connection configuration of the integration.
  7. Client ID and Application ID are the same value and can be used interchangeably.
  8. Enter the scopes
InputNotesExample
Authorize URL

The 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
Client ID

Client Identifier of your Acrobat Sign App (shown as Application ID inside Acrobat Sign).

CBJCHBCAABAApRvVMBVyo0bIo4jdPROKiKWR9xRhRugJ
Client Secret

Client Secret of your Acrobat Sign App.

Refresh URL

The 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 refresh URL would be 'https://secure.na3.adobesign.com/oauth/v2/refresh'

https://secure.na3.adobesign.com/oauth/v2/refresh
Scopes

Space-separated OAuth 2.0 permission scopes for Acrobat Sign. Add scope modifiers using colons. See the <a href="https://opensource.adobe.com/acrobat-sign/developer_guide/gstarted.html#configure-scopes">Acrobat Sign scopes documentation</a> for available scopes.

user_read:account user_write:self agreement_read:group
Token URL

The 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

Triggers​

Webhook​

Receive and validate webhook requests from Adobe Sign for webhooks you configure. | key: adobeSignTrigger

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Perform Strict Validation

When true, performs strict validation on each webhook notification.

false

An Adobe Acrobat Sign webhook can be configured to send notifications to a flow's webhook URL when events occur in the Adobe Sign account (an agreement is created, signed, recalled, etc.).

How It Works​

Adobe Sign requires that all webhook endpoints echo back the X-AdobeSign-ClientId header in every response. This trigger automatically handles that verification by reading the client ID from the incoming request headers and including it in the response.

When Perform Strict Validation is enabled, the trigger also compares the incoming X-AdobeSign-ClientId header against the client ID stored in the connection. If the values do not match, the trigger returns a 401 Unauthorized response and the payload is rejected. This provides an additional layer of security to ensure that only legitimate Adobe Sign requests are processed.

Configuration​

  • Connection: The Adobe Acrobat Sign connection to use. When strict validation is enabled, the connection's client ID is used to verify incoming requests.
  • Perform Strict Validation: When enabled, the trigger compares the X-AdobeSign-ClientId header from each incoming request against the connection's client ID. Requests with a mismatched client ID are rejected with a 401 response. Disabled by default.

Setting Up Webhooks in Adobe Sign​

  1. Log in to Adobe Acrobat Sign and navigate to Account > Webhooks.
  2. Click Create Webhook (the "+" icon).
  3. Enter a Name for the webhook.
  4. Set the Scope (Account, Group, User, or Resource).
  5. Paste the flow's webhook URL into the URL field.
  6. Select the Events to subscribe to (e.g., Agreement All Events, Agreement Created, Agreement Signed).
  7. Click Save.

Adobe Sign will send a verification request to the webhook URL. The trigger automatically responds with the required X-AdobeSign-ClientId header to complete the verification.

Returned Data​

The trigger passes through the full webhook payload as received from Adobe Sign. The payload structure varies by event type.

Example Payload
{
  "webhookId": "CBJCHBCAABAAqz5U6lTZ",
  "webhookName": "Agreement Events",
  "webhookNotificationId": "5a05-b4a1-7de3-ae68",
  "webhookUrlInfo": {
    "url": "https://hooks.example.com/trigger/example"
  },
  "webhookScope": "ACCOUNT",
  "webhookNotificationApplicableUsers": [
    {
      "id": "CBJCHBCAABAAc8PjNTED",
      "email": "user@example.com",
      "role": "SENDER",
      "payloadApplicable": true
    }
  ],
  "event": "AGREEMENT_CREATED",
  "subEvent": "CREATED",
  "eventDate": "2024-01-15T10:30:00Z",
  "eventResourceType": "agreement",
  "eventResourceParentType": "NA",
  "eventResourceParentId": "",
  "participantUserId": "CBJCHBCAABAAc8PjNTED",
  "participantUserEmail": "user@example.com",
  "actingUserId": "CBJCHBCAABAAc8PjNTED",
  "actingUserEmail": "user@example.com",
  "actingUserIpAddress": "192.0.2.1",
  "initiatingUserId": "CBJCHBCAABAAc8PjNTED",
  "initiatingUserEmail": "user@example.com",
  "agreement": {
    "id": "CBJCHBCAABAAnRx1zWdf",
    "name": "Sample Agreement",
    "status": "OUT_FOR_SIGNATURE"
  }
}

Notes​

  • The trigger always responds with the X-AdobeSign-ClientId header, which is required by Adobe Sign's webhook verification protocol. This is handled automatically and no additional configuration is needed.
  • Enable Perform Strict Validation in production environments to ensure only requests from the expected Adobe Sign application are processed.
  • For a full list of available webhook events, refer to the Adobe Sign Webhook API documentation.

Data Sources​

Select Agreements​

A picklist of all agreements under this account, separated byName - Display Date | key: selectAgreements | type: picklist

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

External ID

Case-sensitive External ID for which you would like to retrieve agreement information. ExternalId is passed in the call to the agreement creation API. <strong>Note:</strong> The externalId value is visible to all participants through the API, so should not be used to contain a sensitive token.

EXT-2024-001
Filter Query

Filter results by matching this text.

Engineering
Group ID

The group identifier, as returned by the group creation API or retrieved from the API to fetch groups.

CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf
Show Hidden Agreements

Fetch all the hidden agreements along with the visible agreements. Default value is true.

true

Select Group​

A picklist of all Acrobat Sign groups under this account. | key: selectGroup | type: picklist

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Filter Query

Filter results by matching this text.

Engineering

Select Users​

A picklist of all Acrobat Sign users under this account. | key: selectUsers | type: picklist

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Filter Query

Filter results by matching this text.

Engineering

Select Webhooks​

A picklist of all Acrobat Sign webhooks under this account. | key: selectWebhooks | type: picklist

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Filter Query

Filter results by matching this text.

Engineering
Scope

Scope of the webhook.

Webhook Resource Type

The type of resource on which webhook was created.

Actions​

Create Account​

Creates an Acrobat Sign account under the partner channel. | key: createAccount

InputNotesExample
Account Type

The type of account to be created.

Company

The company of the user.

Acme Corporation
Connection

The Adobe Acrobat Sign connection to use.

Country Code

The country code of the account.

US
Email

The email address of the user to be created.

john.doe@example.com
External ID

Case-sensitive External ID for which you would like to retrieve agreement information. ExternalId is passed in the call to the agreement creation API. <strong>Note:</strong> The externalId value is visible to all participants through the API, so should not be used to contain a sensitive token.

EXT-2024-001
First Name

The first name of the user.

John
Last Name

The last name of the user.

Doe
Locale

The locale of the user.

en_US
Number of Seats

The number of seats.

10
Phone

The phone number of the user.

+1-555-123-4567
Title

The job title of the user.

Sales Manager
Trial Duration Days

Account trial duration (in days).

30

{
  "data": {
    "adminUserInfo": {
      "email": "example@acme.com",
      "firstName": "Acme",
      "lastName": "Test",
      "locale": "en_US",
      "phone": "555-555-5555",
      "title": "Software Engineer"
    },
    "accountType": "FREE",
    "countryCode": "US",
    "numSeats": 1,
    "company": "Acme",
    "externalId": "1234",
    "locale": "en_US",
    "trialDuration": 30
  }
}

Create Agreement​

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

InputNotesExample
Additional Agreement Participants

Additional participant sets to include in the agreement. Provide a JSON array of participantSetsInfo objects to support multiple signers or other roles.

Agreement Name

Name of the Agreement that will be used to identify it.

Service Agreement 2024
Agreement State

State of the agreement.

Connection

The Adobe Acrobat Sign connection to use.

Participant Member Info Email

Email address of the participant.

john.doe@example.com
Participant Set Info Role

Role assumed by all participants in this set (signer, approver, etc.).

Signature Type

The type of signature you would like to request - written or e-signature.

Transient Document ID

ID for a transient document that will be added to the agreement.

3AAABLblqZhBf0aJb0XZqz5vXy8g3V9R3qQx6

{
  "data": {
    "fileInfos": [
      {
        "transientDocumentId": "3AAABLblqZhBf0aJb0XZqz5vXy8g3V9R3qQx6..."
      }
    ],
    "name": "Test Agreement",
    "signatureType": "ESIGN",
    "state": "IN_PROCESS",
    "participantSetsInfo": [
      {
        "order": 1,
        "role": "SIGNER",
        "memberInfos": [
          {
            "email": "example@company.com"
          }
        ]
      }
    ]
  }
}

Create Group​

Creates a new group in an account. | key: createGroup

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Created

Date of creation of the group. Format would be yyyy-MM-dd'T'HH:mm:ssZ

2024-01-15T10:30:00Z
Group Name

The name of the group.

Engineering Team
Is Default Group

When true, the group is the default group.

{
  "data": {
    "id": "CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf"
  }
}

Create Transient Document​

Uploads a document and obtains the document's ID. | key: createTransientDocument

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

File

The file part of the multipart request for document upload. You can upload only one file at a time.

File Name

A name for the document being uploaded. Maximum number of characters in the name is restricted to 255.

contract.pdf
Mime Type

The 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.

application/pdf

{
  "data": {
    "file": {
      "data": "<10000 bytes>"
    },
    "fileName": "Test Document.pdf",
    "mimeType": "application/pdf"
  }
}

Create User​

Creates a new user in the Acrobat Sign system. | key: createUser

InputNotesExample
Account ID

The account ID of the user.

CBJCHBCAABAAxxxxxxxxxxxxxxxxxxxxxxxxxx
Company

The company of the user.

Acme Corporation
Connection

The Adobe Acrobat Sign connection to use.

Email

The email address of the user to be created.

john.doe@example.com
First Name

The first name of the user.

John
Initials

The initials of the user.

JD
Account Admin

When true, the user is an account admin.

false
Last Name

The last name of the user.

Doe
Locale

The locale of the user.

en_US
Phone

The phone number of the user.

+1-555-123-4567
Title

The job title of the user.

Sales Manager

{
  "data": {
    "email": "example@company.com",
    "isAccountAdmin": true,
    "accountId": "someId",
    "company": "Acme",
    "firstName": "Acme",
    "initials": "Acme",
    "lastName": "Test",
    "locale": "en_US",
    "phone": "555-555-5555",
    "title": "Software Engineer"
  }
}

Create Webhook​

Creates a webhook. | key: createWebhook

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Scope

Scope of the webhook.

Webhook Agreement Conditional Parameters

Optional parameters to include additional information in the webhook payload for agreements.

Application Display Name

The name of the application through which the webhook is created.

My Integration App
Application Name

The name of the application through which the webhook is created.

my-integration-app
Webhook Library Documents Conditional Parameters

Optional parameters to include additional information in the webhook payload for library documents.

Webhook MegaSign Conditional Parameters

Optional parameters to include additional information in the webhook payload for MegaSign.

Webhook Name

The name of the webhook.

Agreement Status Webhook
Problem Notification Emails

The list of email addresses to which the webhook problem notifications are sent.

["admin@example.com", "support@example.com"]
Resource ID

ID 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. <strong>Note:</strong> Only specify if scope is 'RESOURCE'.

3AAABLblqZhBf0aJb0XZqz5vXy8g3V9R3qQx6
Webhook Resource Type

The type of resource being accessed. <strong>Note:</strong> Only specify if scope is Resource.

Webhook Subscription Events

The list of events for which the webhook subscription is being made.

Webhook URL

The URL to which the webhook payload is to be delivered.

https://your-webhook-endpoint.com/webhook/abc123
Webhook Widget Conditional Parameters

Optional parameters to include additional information in the webhook payload for widgets.

{
  "data": {
    "name": "Test Webhook",
    "scope": "ACCOUNT",
    "state": "ACTIVE",
    "webhookUrlInfo": {
      "url": "<Your Integration trigger url here>"
    },
    "webhookSubscriptionEvents": [
      "AGREEMENT_ALL"
    ],
    "webhookConditionalParams": {
      "webhookAgreementEvents": {
        "includeDetailedInfo": true,
        "includeDocumentsInfo": true,
        "includeParticipantsInfo": true,
        "includeSignedDocuments": true
      }
    }
  }
}

Delete Agreement Documents​

Deletes all the documents for an agreement. | key: deleteAgreementDocuments

InputNotesExample
Agreement ID

The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.

3AAABLblqZhBf0aJb0XZqz5vXy8g3V9R3qQx6
Connection

The Adobe Acrobat Sign connection to use.

Delete Group​

Delete an existing group. | key: deleteGroup

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Group ID

The unique identifier of the group.

CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf

{
  "data": {}
}

Delete Webhook​

Deletes a webhook. | key: deleteWebhook

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Webhook ID

The webhook identifier, as returned by the Adobe Sign Webhook API.

CBJCHBCAABAAxxxxxxxxxxxxxxxxxxxxxxxxxx

Download Agreement PDF​

Downloads the PDF associated with an agreement. | key: downloadAgreementFile

InputNotesExample
Agreement ID

The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.

3AAABLblqZhBf0aJb0XZqz5vXy8g3V9R3qQx6
Connection

The Adobe Acrobat Sign connection to use.

Get Account​

Retrieves the information for an account. | key: getAccount

InputNotesExample
Account ID

The account ID of the user.

CBJCHBCAABAAxxxxxxxxxxxxxxxxxxxxxxxxxx
Connection

The Adobe Acrobat Sign connection to use.

Get Agreement​

Retrieves the current status of an agreement. | key: getAgreement

InputNotesExample
Agreement ID

The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.

3AAABLblqZhBf0aJb0XZqz5vXy8g3V9R3qQx6
Connection

The Adobe Acrobat Sign connection to use.

Get Group​

Retrieves detailed information about the group. | key: getGroup

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Group ID

The unique identifier of the group.

CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf

{
  "data": {
    "groupId": "CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf",
    "createdDate": "2023-12-06T22:02:50Z",
    "groupName": "Default Group",
    "isDefaultGroup": true
  }
}

Get User​

Retrieves detailed information about the user in the caller account. | key: getUser

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

User ID

The user identifier, as returned by the user creation API or retrieved from the API to fetch users.

CBJCHBCAABAApRvVMBVyo0bIo4jdPROKiKWR9xRhRugJ

Get Webhook​

Retrieves the details of a webhook. | key: getWebhook

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Webhook ID

The webhook identifier, as returned by the Adobe Sign Webhook API.

CBJCHBCAABAAxxxxxxxxxxxxxxxxxxxxxxxxxx

List Agreements​

Retrieves agreements for the user. | key: listAgreements

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Cursor

Used to navigate through pagination. If not provided, it will default to the first page.

External ID

Case-sensitive External ID for which you would like to retrieve agreement information. ExternalId is passed in the call to the agreement creation API. <strong>Note:</strong> The externalId value is visible to all participants through the API, so should not be used to contain a sensitive token.

EXT-2024-001
Group ID

The group identifier, as returned by the group creation API or retrieved from the API to fetch groups.

CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf
Page Size

The number of results to return per page. If not provided, it is decided by your application settings.

100
Show Hidden Agreements

When true, fetches all the hidden agreements along with the visible agreements. Default value is false.

false

List Group Events​

Retrieves all events for group | key: listGroupEvents

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Cursor

Used to navigate through pagination. If not provided, it will default to the first page.

Group ID

The unique identifier of the group.

CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf
Page Size

The number of results to return per page. If not provided, it is decided by your application settings.

100

{
  "data": [
    {
      "groupEventId": "CBJCHBCAABAA82chKH_73ytJxSou5uTTrIh7rRelwSro",
      "date": "2023-12-06T22:02:49Z",
      "event": "CREATED",
      "accountId": "CBJCHBCAABAAd4TPldfK4H2cTTDlWxJ6i4JDiVDoOC2C",
      "groupId": "CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf"
    },
    {
      "groupEventId": "CBJCHBCAABAA82chKH_73ytJxSou5uTTrIh7rRelwSro",
      "date": "2023-12-06T22:02:49Z",
      "event": "CREATED",
      "accountId": "CBJCHBCAABAAd4TPldfK4H2cTTDlWxJ6i4JDiVDoOC2C",
      "groupId": "CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf"
    }
  ]
}

List Group Users​

Retrieves all the users in a group. | key: listGroupUsers

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Cursor

Used to navigate through pagination. If not provided, it will default to the first page.

Group ID

The unique identifier of the group.

CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf
Page Size

The number of results to return per page. If not provided, it is decided by your application settings.

100

{
  "data": [
    {
      "email": "example@acme.io",
      "company": "Acme",
      "id": "CBJCHBCAABAApRvVMBVyo0bIo4jdPROKiKWR9xRhRugJ",
      "firstName": "Thomas",
      "lastName": "Tedrow",
      "isGroupAdmin": false
    },
    {
      "email": "example@acme.io",
      "company": "Acme",
      "id": "CBJCHBCAABAApRvVMBVyo0bIo4jdPROKiKWR9xRhRugJ",
      "firstName": "Thomas",
      "lastName": "Tedrow",
      "isGroupAdmin": false
    }
  ]
}

List Groups​

Retrieve a list of groups in the Adobe Sign account. | key: listGroups

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Cursor

Used to navigate through pagination. If not provided, it will default to the first page.

Page Size

The number of results to return per page. If not provided, it is decided by your application settings.

100

{
  "data": [
    {
      "groupId": "CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf",
      "createdDate": "2023-12-06T22:02:50Z",
      "groupName": "Default Group",
      "isDefaultGroup": true
    },
    {
      "groupId": "CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf",
      "createdDate": "2023-12-06T22:02:50Z",
      "groupName": "Default Group",
      "isDefaultGroup": true
    }
  ]
}

List Users​

Retrieves all the users in an account. | key: listUsers

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Cursor

Used to navigate through pagination. If not provided, it will default to the first page.

Page Size

The number of results to return per page. If not provided, it is decided by your application settings.

100

List Webhooks​

Retrieves webhooks for a user. | key: listWebhooks

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Cursor

Used to navigate through pagination. If not provided, it will default to the first page.

Page Size

The number of results to return per page. If not provided, it is decided by your application settings.

100
Scope

Filter for webhooks with a specific scope.

Show Inactive Webhooks

When true, fetches all the inactive webhooks along with the active webhooks. Default value is false.

false
Webhook Resource Type

The type of resource being accessed. <strong>Note:</strong> Only specify if scope is Resource.

Raw Request​

Send raw HTTP request to Adobe Acrobat Sign | key: rawRequest

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A 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.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If 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
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/agreements). The base URL is already included. For example, in order to send an agreements request, only /agreements is entered in this field.

/agreements
Use Exponential Backoff

Specifies 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 | key: searchResources

InputNotesExample
Asset ID(s)

A filter against case-sensitive agreement asset ID for which you would like to retrieve the information.

["3AAABLblqZhBf0aJb0XZqz5vXy8g3V9R3qQx6"]
Connection

The Adobe Acrobat Sign connection to use.

Created Greater Than Date

The 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. If terms are mixed the JSON will be considered malformed.

2024-01-01T00:00:00Z
Expiration Greater Than Date

The 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. If terms are mixed the JSON will be considered malformed.

2024-01-01T00:00:00Z
Modified Greater Than Date

The minimum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.

2024-01-01T00:00:00Z
Created Less Than Date

The 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.

2024-12-31T23:59:59Z
Expiration Less Than Date

The 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.

2024-12-31T23:59:59Z
Modified Less Than Date

The maximum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.

2024-12-31T23:59:59Z
Created Max Date

The 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.

2024-12-31T23:59:59Z
Expiration Max Date

The 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.

2024-12-31T23:59:59Z
Modified Max Date

The maximum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.

2024-12-31T23:59:59Z
Created Min Date

The 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.

2024-01-01T00:00:00Z
Expiration Min Date

The 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. If terms are mixed the JSON will be considered malformed.

2024-01-01T00:00:00Z
Modified Min Date

The minimum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.

2024-01-01T00:00:00Z
External ID

A 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.

EXT-2024-001
Group ID

A filter against group identifier(s), as returned by the group creation API or retrieved from the API to fetch groups.

CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf
Library Document ID

A filter against case-sensitive library document ID that was used to create an agreement. This filter will only apply for the sender of the agreement since signers don't have the knowledge of how the agreement was created. Also, this filter only applies to library documents with type DOCUMENT but not FORM_FIELD_LAYER.

3AAABLblqZhBf0aJb0XZqz5vXy8g3V9R3qQx6
Ownership Scope

Ownership scope of the agreement documents to include in this search request. Default is 'OWNED'.

Page Size

The number of results to return per page. If not provided, it is decided by your application settings.

100
Parent ID

A filter against case-sensitive parent ID for which you would like to retrieve agreement asset information.

["3AAABLblqZhBf0aJb0XZqz5vXy8g3V9R3qQx6"]
Participant Email

A filter against participant emails for which you would like to retrieve agreement asset information.

["john.doe@example.com", "jane.smith@example.com"]
Queryable Fields

A list of field names against which string query specified in the 'query' field above is executed. For more information, see the <a href="https://helpx.adobe.com/sign/using/adobesign-search-users-agreements.html#NamePrefix">Acrobat Sign search documentation</a>.

Query

This field provides text search capability against terms in the field values of agreements that are visible to the user making the request. For more information about how text searching works, see the <a href="https://helpx.adobe.com/sign/using/adobesign-search-users-agreements.html#HowSearchWorks">Acrobat Sign search documentation</a>.

contract agreement
Role

A filter against the roles the user has on agreement assets.

Status

A filter against the detailed status of the agreement asset. <strong>Note:</strong> PARTIAL and DRAFT agreements are not supported for search.

Type

A filter against the agreement asset type.

User ID

A filter against the user for account sharing.

["CBJCHBCAABAApRvVMBVyo0bIo4jdPROKiKWR9xRhRugJ"]
Workflow ID

A filter against case-sensitive workflow ID for which you would like to retrieve agreement asset information. Workflow ID is passed in the call to the agreement asset creation API.

["3AAABLblqZhBf0aJb0XZqz5vXy8g3V9R3qQx6"]
Sort By Field

Defines the field by which the results will be ordered.

Sort Order

Sets the direction of the order.

Start Index

0-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.

0
Sub Types

A filter against the agreement asset sub types. Only agreement assets with type LIBRARY_TEMPLATE currently have this field populated.

Visibility

A filter indicating the visibility level of agreements that get returned in the response.

{
  "data": {
    "scope": [
      "AGREEMENT_ASSETS"
    ],
    "agreementAssetsCriteria": {
      "createdDate": {
        "range": {
          "gt": "2024-01-01T00:00:00Z",
          "lt": "2024-01-01T23:00:00Z"
        }
      }
    }
  }
}

Update Agreement​

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

InputNotesExample
Agreement ID

The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements.

3AAABLblqZhBf0aJb0XZqz5vXy8g3V9R3qQx6
Agreement State

State of the agreement.

Connection

The Adobe Acrobat Sign connection to use.

Expiration Date

A range filter against the agreement expiration date. Format would be date-time with an offset from UTC/Greenwich in the ISO-8601 format, such as 2007-12-03T10:15:30+01:00. Range terms can be defined as less-than/greater-than or min/max.

2024-12-31T23:59:59+00:00
Participant Set Info Role

Role assumed by all participants in this set (signer, approver, etc.).

Signature Type

The type of signature you would like to request - written or e-signature.

Transient Document ID

ID for a transient document that will be added to the agreement.

3AAABLblqZhBf0aJb0XZqz5vXy8g3V9R3qQx6

{
  "data": {
    "fileInfos": [
      {
        "transientDocumentId": "3AAABLblqZhBf0aJb0XZqz5vXy8g3V9R3qQx6..."
      }
    ],
    "name": "Test Agreement",
    "signatureType": "ESIGN",
    "state": "IN_PROCESS",
    "participantSetsInfo": [
      {
        "order": 1,
        "role": "SIGNER",
        "memberInfos": [
          {
            "email": "example@company.com"
          }
        ]
      }
    ]
  }
}

Update Group​

Update an existing group. | key: updateGroup

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Created

Date of creation of the group. Format would be yyyy-MM-dd'T'HH:mm:ssZ

2024-01-15T10:30:00Z
Group ID

The unique identifier of the group.

CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf
Group Name

The name of the group.

Engineering Team
Is Default Group

When true, the group is the default group.

{
  "data": {
    "id": "CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf"
  }
}

Update User​

Update a user in the Acrobat Sign system. | key: updateUser

InputNotesExample
Company

The company of the user.

Acme Corporation
Connection

The Adobe Acrobat Sign connection to use.

Email

The email address of the user to be created.

john.doe@example.com
First Name

The first name of the user.

John
Initials

The initials of the user.

JD
Last Name

The last name of the user.

Doe
Locale

The locale of the user.

en_US
Phone

The phone number of the user.

+1-555-123-4567
Title

The job title of the user.

Sales Manager
User ID

The user identifier, as returned by the user creation API or retrieved from the API to fetch users.

CBJCHBCAABAApRvVMBVyo0bIo4jdPROKiKWR9xRhRugJ
Status

Status of the user.

{
  "data": {
    "email": "replacedEmail@acme.io",
    "company": "Not Acme"
  }
}

Update Webhook​

Updates a webhook | key: updateWebhook

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Scope

Scope of the webhook.

Webhook Agreement Conditional Parameters

Optional parameters to include additional information in the webhook payload for agreements.

Application Display Name

The name of the application through which the webhook is created.

My Integration App
Application Name

The name of the application through which the webhook is created.

my-integration-app
Webhook ID

The webhook identifier, as returned by the Adobe Sign Webhook API.

CBJCHBCAABAAxxxxxxxxxxxxxxxxxxxxxxxxxx
Webhook Library Documents Conditional Parameters

Optional parameters to include additional information in the webhook payload for library documents.

Webhook MegaSign Conditional Parameters

Optional parameters to include additional information in the webhook payload for MegaSign.

Webhook Name

The name of the webhook.

Agreement Status Webhook
Problem Notification Emails

The list of email addresses to which the webhook problem notifications are sent.

["admin@example.com", "support@example.com"]
Webhook Subscription Events

The list of events for which the webhook subscription is being made.

Webhook URL

The URL to which the webhook payload is to be delivered.

https://your-webhook-endpoint.com/webhook/abc123
Webhook Widget Conditional Parameters

Optional parameters to include additional information in the webhook payload for widgets.

{
  "data": {
    "name": "Test Webhook",
    "scope": "ACCOUNT",
    "state": "ACTIVE",
    "webhookUrlInfo": {
      "url": "<Your Integration trigger url here>"
    },
    "webhookSubscriptionEvents": [
      "AGREEMENT_ALL"
    ]
  }
}

Changelog​

2026-04-07​

Added trigger documentation

2026-03-31​

Various modernizations and documentation updates

2026-03-30​

Added Additional Agreement Participants input to the Create Agreement action to support multiple signers and participant roles

2025-10-03​

Added inline data sources for agreements, users, groups, and webhooks to enhance data selection capabilities