Skip to main content
adobe-acrobat-sign icon

Adobe Acrobat Sign Connector

Sourcenpm · v0.3.0API DocsAPI ChangelogConnector Changelog

Description​

Adobe Acrobat Sign is an e-signature management solution. This component allows you to send, sign, track, and manage agreements through the Adobe Acrobat Sign platform.

API Documentation​

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

Connections​

OAuth 2.0​

key: oauth

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

Prerequisites​

  • An Adobe Acrobat Sign account with access to API Applications.
  • Permission to create OAuth applications in the Adobe Acrobat Sign account.
  • The region/shard of the Adobe Acrobat Sign account (visible in the web app URL, e.g. https://secure.na3.adobesign.com).

Setup Steps​

  1. Log in to Adobe Acrobat Sign.
  2. Select API from the top menu. If the API link is not visible, select Account first.
  3. Select API Applications.
  4. Select the Create (+) icon at the top right of the table and provide application details.
  5. Choose a domain based on the intended use:
    • CUSTOMER: Apps that only access the creating account or are used for internal use and testing.
    • PARTNER: Select this type for applications distributed to other users that require access to other Adobe Acrobat Sign accounts. Note: PARTNER applications must be certified to have full access to other accounts.
  6. To retrieve the OAuth Client ID and Secret: in the API Applications menu, select the application.
  7. Click the Configure OAuth for the Application link to configure the OAuth integration.
  8. For the Redirect URI, enter https://oauth2.prismatic.io/callback.
  9. Check the boxes for the necessary scopes with the modifier set to account for the integration and save.
  10. In the API Applications menu, select the application and select View / Edit.
  11. Copy the Application ID / Client ID and Client Secret values. (Client ID and Application ID are the same value and can be used interchangeably.)

Configure the Connection​

Each Adobe Acrobat Sign OAuth URL is region-dependent. Replace the shard (e.g. na3) in the host with the shard shown in the Adobe Acrobat Sign web app URL (for example, an https://secure.na3.adobesign.com web app uses na3).

  • Authorize URL: The OAuth 2.0 authorization endpoint for the region. Example: https://secure.na3.adobesign.com/public/oauth/v2.
  • Token URL: The OAuth 2.0 token endpoint for the region. Example: https://secure.na3.adobesign.com/oauth/v2/token.
  • Refresh URL: The OAuth 2.0 refresh endpoint for the region. Example: https://secure.na3.adobesign.com/oauth/v2/refresh.
  • Scopes: Space-separated OAuth 2.0 permission scopes for Adobe Acrobat Sign, with the modifier set to account (for example, user_read:account user_write:self agreement_read:group). Refer to the Acrobat Sign scopes documentation for the available scopes.
  • Client ID: The Application ID / Client ID copied from the API Application.
  • Client Secret: The Client Secret copied from the API Application.

PARTNER Application Certification​

Adobe requires PARTNER domain apps (those designed to access multiple organizations' Adobe Acrobat Sign accounts) to complete a certification process before deployment. This review verifies the app meets Adobe's security and compliance requirements for handling enterprise e-signature data on behalf of external accounts.

Complete PARTNER application certification before deploying to customer accounts. Without certification, a PARTNER app is limited to authenticating with the developing organization's own Adobe Acrobat Sign account. Users from other organizations cannot connect to the integration.

To apply for certification:

  1. Ensure the PARTNER application is fully developed and tested using the developing organization's own Adobe Acrobat Sign account.
  2. Complete the PARTNER Application Certification form.
  3. Submit the form. Adobe reviews the application for security and compliance requirements.
  4. Once certified, the PARTNER application can be authorized by users from other organizations' Adobe Acrobat Sign accounts.
Certification Applies to PARTNER Domain Only

CUSTOMER domain applications do not require certification and can only access the account used to create the app. Only select the PARTNER domain if the integration needs to access other organizations' Adobe Acrobat Sign accounts. Refer to the Acrobat Sign developer guide for details on choosing the correct domain.

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​

New and Updated Agreements​

Retrieves existing and ongoing agreements from Adobe Acrobat Sign. Load history once, check for changes on a schedule, or both. | key: pollChangesTrigger

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Look-back Date

The date the initial sync starts from, in YYYY-MM-DD format. Cannot be a future date. Leave empty to start from the first recurrence with no backfill. When set, the initial sync seeds each record modified on or after this date once, ignoring the field and visibility filters.

2026-01-01
Show New Records

When true, newly created agreements are included in the trigger output.

true
Show Updated Records

When true, agreements updated since the last poll are included in the trigger output.

true

This trigger retrieves existing and ongoing agreements from Adobe Acrobat Sign. Load history once, check for changes on a schedule, or both.

How It Works​

On each scheduled recurrence, the trigger calls the Adobe Acrobat Sign Search API with a modifiedDate.range.min filter set to the last poll time, sorted ascending by MODIFIED_DATE. Each returned agreement is classified as created when its createdDate is after the last poll time, and otherwise as updated. The trigger then advances its cursor.

When no cursor exists and no Look-back Date is set, the trigger bootstraps with a 24-hour lookback so the API's required modifiedDate filter has a valid value.

Initial sync

An initial sync seeds a complete starting state rather than a change feed, so inputs that narrow which changes are reported would leave gaps: Show New Records and Show Updated Records are ignored while it runs, and are the only inputs it ignores. It begins on the first recurrence when the trigger has no stored position and a Look-back Date (YYYY-MM-DD) is set, and seeds every agreement modified on or after that date exactly once. Left empty, there is no sync and the trigger starts from its first recurrence.

The window has no fixed upper bound, so an agreement modified mid-drain is swept into the sync. With batching off, each recurrence fetches up to 50 pages (5,000 agreements); if more remain it rebases the watermark to the latest modified date it received and continues from offset 0 on the next scheduled recurrence. With batching on, each round fetches one page and the platform drives successive rounds via pagination state until the stream is drained. Once drained, the trigger advances lastPolledAt to the wall clock and incremental polling begins from there. Nothing in the payload marks the handoff.

The trigger has no page-size or field-selection input, so nothing else is suppressed.

Batching

Batching is enabled per flow on this trigger: each changed record is dispatched as its own execution, or grouped by the configured batch size. Batch size and batch concurrency can both be overridden per instance. Raising concurrency increases the request volume sent to Adobe Acrobat Sign.

To turn it on, select the flow's trigger, open the Flow control tab, and switch on Enable Batching. Under Batch Size, keep Trigger default or choose Custom batch size. Batch Concurrency is optional; leave it blank for no batch-level limit.

With batching off, downstream steps read results.body.data.created and results.body.data.updated. With batching on, those fields do not exist — each execution receives a single { changeType, record } object. Any step reading the older shape must be updated before batching is enabled. Because batching is enabled per flow, the change is scoped to that flow.

Returned Data​

The trigger returns an object with two arrays — created for new agreements and updated for modified agreements. Fields shown are representative. The full response object includes additional properties.

Example Payload for New and Updated Agreements⤓
Loading…

Webhook​

Receive and validate webhook requests from Adobe Acrobat Sign for manually configured webhook subscriptions. | 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 Acrobat Sign account (an agreement is created, signed, recalled, etc.).

How It Works​

Adobe Acrobat 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 Acrobat Sign requests are processed.

Event Types​

Available Events (10)
EventDescription
AGREEMENT_CREATEDAn agreement was created (for example, as a draft) in Adobe Acrobat Sign.
AGREEMENT_ACTION_REQUESTEDAn action (such as signing) was requested from a participant on an agreement.
AGREEMENT_ACTION_COMPLETEDA participant completed a requested action (such as signing) on an agreement.
AGREEMENT_WORKFLOW_COMPLETEDAll participants completed their actions and the agreement workflow is fully completed.
AGREEMENT_EXPIREDAn agreement reached its expiration date before being completed.
AGREEMENT_CANCELLEDAn agreement was cancelled (for example, by a sender or admin).
AGREEMENT_RECALLEDAn agreement was recalled by the sender before completion.
AGREEMENT_REMINDER_SENTA reminder was sent to a participant for an outstanding agreement.
AGREEMENT_VAULTEDAn agreement was vaulted (archived to a long-term storage provider).
AGREEMENT_DOCUMENT_VIEWEDA participant viewed the agreement document.

Refer to the Adobe Acrobat Sign webhook documentation for the complete and up-to-date list of webhook events and payload structures.

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.

Configure the Webhook in Adobe Acrobat 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 Acrobat 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 Acrobat 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",
  "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 the Adobe Acrobat Sign 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 Acrobat Sign application are processed.
  • For a full list of available webhook events, refer to the Adobe Acrobat Sign Webhook API documentation.

Data Sources​

Select Agreements​

Retrieves a picklist of all agreements under this account, labeled as Name - 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​

Retrieves a picklist of all Adobe 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​

Retrieves a picklist of all Adobe 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​

Retrieves a picklist of all Adobe 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 Adobe Acrobat Sign account under the partner channel. | key: createAccount

InputNotesExample
Account Type

The type of account to be created.

Additional Fields

Additional optional fields.

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
First Name

The first name of the user.

John
Last Name

The last name of the user.

Doe
Number of Seats

The number of seats.

10
Phone

The phone number of the user.

+1-555-123-4567
Example Payload for Create Account⤓
Loading…

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.

[
  {
    "memberInfos": [
      {
        "email": "signer2@example.com"
      }
    ],
    "order": 2,
    "role": "SIGNER"
  }
]
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
Example Payload for Create Agreement⤓
Loading…

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.

Example Payload for Create Group⤓
Loading…

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
Example Payload for Create Transient Document⤓
Loading…

Create User​

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

InputNotesExample
Additional Fields

Additional optional fields.

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
Phone

The phone number of the user.

+1-555-123-4567
Example Payload for Create User⤓
Loading…

Create Webhook​

Creates a webhook for the authenticated user. | 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.

Webhook Application

The application name and display name through which the webhook is created.

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.

Example Payload for Create Webhook⤓
Loading…

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.

Example Payload for Delete Agreement Documents⤓
Loading…

Delete Group​

Deletes an existing group. | key: deleteGroup

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Group ID

The unique identifier of the group.

CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf
Example Payload for Delete Group⤓
Loading…

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
Example Payload for Delete Webhook⤓
Loading…

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.

Example Payload for Download Agreement PDF⤓
Loading…

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.

Example Payload for Get Account⤓
Loading…

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.

Example Payload for Get Agreement⤓
Loading…

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
Example Payload for Get Group⤓
Loading…

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
Example Payload for Get User⤓
Loading…

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
Example Payload for Get Webhook⤓
Loading…

List Agreements​

Retrieves agreements for the user. | key: listAgreements

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
Fetch All

When true, automatically fetches all pages of results using pagination.

true
Group ID

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

CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf
Pagination

Page and page-size controls.

Show Hidden Agreements

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

false
Example Payload for List Agreements⤓
Loading…

List Group Events​

Retrieves all events for a group. | key: listGroupEvents

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination.

true
Group ID

The unique identifier of the group.

CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf
Pagination

Page and page-size controls.

Example Payload for List Group Events⤓
Loading…

List Group Users​

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

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination.

true
Group ID

The unique identifier of the group.

CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf
Pagination

Page and page-size controls.

Example Payload for List Group Users⤓
Loading…

List Groups​

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

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination.

true
Pagination

Page and page-size controls.

Example Payload for List Groups⤓
Loading…

List Users​

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

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination.

true
Pagination

Page and page-size controls.

Example Payload for List Users⤓
Loading…

List Webhooks​

Retrieves webhooks for a user. | key: listWebhooks

InputNotesExample
Connection

The Adobe Acrobat Sign connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination.

true
Pagination

Page and page-size controls.

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.

Example Payload for List Webhooks⤓
Loading…

Raw Request​

Sends a 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 authenticated 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.

Example Payload for Search Resources⤓
Loading…

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

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 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
Example Payload for Update Agreement⤓
Loading…

Update Group​

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

Example Payload for Update Group⤓
Loading…

Update User​

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

InputNotesExample
Additional Fields

Additional optional fields.

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
Phone

The phone number of the user.

+1-555-123-4567
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.

Example Payload for Update User⤓
Loading…

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.

Webhook Application

The application name and display name through which the webhook is created.

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.

Example Payload for Update Webhook⤓
Loading…

Changelog​

2026-11-09​

Updated spectral to 10.39.1

2026-11-05​

Updated spectral to 10.39.0

2026-11-03​

Published the component as an npm package, so code-native integrations can install it and call its actions, triggers and data sources from code with TypeScript types

2026-10-20​

Updated the New and Updated Agreements polling trigger with batching and initial sync support:

  • Added opt-in batching to the New and Updated Agreements trigger, dispatching each changed record individually or in configured batches so large backlogs drain in one recurrence; enabling it changes the shape a downstream step receives
  • Added an optional Look-back Date input for performing an initial sync of records. The initial sync begins on the first recurrence and backfills every record modified on or after the specified date, seeding each once and ignoring the visibility filters; later recurrences are unaffected. Leave it empty to start from the first recurrence with no backfill

2026-08-05​

Removed the deprecated webhookNotificationApplicableUsers field from the webhook trigger's example payload, aligning the documentation with Adobe Acrobat Sign's July 2025 webhook payload change

2026-07-01​

Restructured action inputs into structured objects for an improved user experience.

  • List actions (List Agreements, List Groups, List Group Events, List Group Users, List Users, and List Webhooks) group their pagination inputs into a Pagination structured object; Fetch All stays a top-level toggle
  • Create Webhook and Update Webhook group their application inputs into a Webhook Application structured object
  • Create User, Update User, and Create Account group their optional inputs into an Additional Fields structured object

2026-06-03​

Added New and Updated Agreements polling trigger that fetches agreements created or modified since the last poll

2026-05-26​

Improved API rate-limit compliance and pagination across list actions and data sources:

2026-04-30​

Updated spectral version

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