What's New
Get Started
- Quick start guide for administrators
- Quick start guide for users
- For Developers
- Video tutorial library
- FAQ
Administer
- Admin Console Overview
- User Management
- Adding users
- Create function-focused users
- Check for users with provisioning errors
- Change Name/Email Address
- Edit a user's group membership
- Edit a user's group membership through the group interface
- Promote a user to an admin role
- User Identity Types and SSO
- Switch User Identity
- Authenticate Users with MS Azure
- Authenticate Users with Google Federation
- Product Profiles
- Login Experience
- Account/Group Settings
- Settings Overview
- Global Settings
- Account tier and ID
- New Recipient Experience
- Self Signing Workflows
- Send in Bulk
- Web Forms
- Custom Send Workflows
- Power Automate Workflows
- Library Documents
- Collect form data with agreements
- Limited Document Visibility
- Attach a PDF copy of the signed agreement
- Include a link in the email
- Include an image in the email
- Files attached to email will be named as
- Attach audit reports to documents
- Merge multiple documents into one
- Download individual documents
- Upload a signed document
- Delegation for users in my account
- Allow external recipients to delegate
- Authority to sign
- Authority to send
- Power to add Electronic Seals
- Set a default time zone
- Set a default date format
- Users in Multiple Groups (UMG)
- Group Administrator Permissions
- Replace recipient
- Audit Report
- In Product Messaging and Guidance
- Accessible PDFs
- New authoring experience
- Healthcare customer
- Account Setup
- Add logo
- Customize company Hostname/URL
- Add company name
- Post agreement URL redirect
- Signature Preferences
- Well formatted signatures
- Allow recipients to sign by
- Signers can change their name
- Allow recipients to use their saved signature
- Custom Terms of Use and Consumer Disclosure
- Navigate recipients through form fields
- Decline to sign
- Allow Stamps workflows
- Require signers to provide their Title or Company
- Allow signers to print and place a written signature
- Show messages when e-signing
- Require signers to use a mobile device to create their signature
- Request IP address from signers
- Exclude company name and title from participation stamps
- Digital Signatures
- Electronic Seals
- Digital Identity
- Report Settings
- New report experience
- Classic report settings
- Security Settings
- Single Sign-on settings
- Remember-me settings
- Login password policy
- Login password strength
- Web session duration
- PDF encryption type
- API
- User and group info access
- Allowed IP Ranges
- Account Sharing
- Account sharing permissions
- Agreement sharing controls
- Signer identity verification
- Agreement signing password
- Document password strength
- Block signers by Geolocation
- Phone Authentication
- Knowledge-Based Authentication (KBA)
- Allow page extraction
- Document link expiration
- Upload a client certificate for webhooks/callbacks
- Timestamp
- Send settings
- Show Send page after login
- Require recipient name when sending
- Lock name values for known users
- Allowed recipient roles
- Allow e-Witnesses
- Recipient groups
- Required fields
- Attaching documents
- Field flattening
- Modify Agreements
- Agreement name
- Languages
- Private messages
- Allowed signature types
- Reminders
- Signed document password protection
- Send Agreement Notification through
- Signer identification options
- Content Protection
- Enable Notarize transactions
- Document Expiration
- Preview, position signatures, and add fields
- Signing order
- Liquid mode
- Custom workflow controls
- Upload options for the e-sign page
- Post-sign confirmation URL redirect
- Message Templates
- Bio-Pharma Settings
- Workflow Integration
- Notarization Settings
- Payments Integration
- Signer Messaging
- SAML Settings
- SAML Configuration
- Install Microsoft Active Directory Federation Service
- Install Okta
- Install OneLogin
- Install Oracle Identity Federation
- SAML Configuration
- Data Governance
- Time Stamp Settings
- External Archive
- Account Languages
- Email Settings
- Migrating from echosign.com to adobesign.com
- Configure Options for Recipients
- Guidance for regulatory requirements
- Accessibility
- HIPAA
- GDPR
- 21 CFR part 11 and EudraLex Annex 11
- Healthcare customers
- IVES support
- "Vaulting" agreements
- EU/UK considerations
- Download Agreements in Bulk
- Claim your domain
- Report Abuse links
Send, Sign, and Manage Agreements
- Recipient Options
- Cancel an email reminder
- Options on the e-signing page
- Overview of the e-sign page
- Open to read the agreement without fields
- Decline to sign an agreement
- Delegate signing authority
- Restart the agreement
- Download a PDF of the agreement
- View the agreement history
- View the agreement messages
- Convert from an electronic to a written signature
- Convert from a written to an electronic signature
- Navigate the form fields
- Clear the data from the form fields
- E-sign page magnification and navigation
- Change the language used in the agreement tools and information
- Review the Legal Notices
- Adjust Acrobat Sign Cookie Preferences
- Send Agreements
- Authoring fields into documents
- In-app authoring environment
- Create forms with text tags
- Create forms using Acrobat (AcroForms)
- Fields
- Authoring FAQ
- Sign Agreements
- Manage Agreements
- Manage page overview
- Delegate agreements
- Replace Recipients
- Limit Document Visibility
- Cancel an Agreement
- Create new reminders
- Review reminders
- Cancel a reminder
- Access Power Automate flows
- More Actions...
- How search works
- View an agreement
- Create a template from an agreement
- Hide/Unhide agreements from view
- Upload a signed agreement
- Modify a sent agreement's files and fields
- Edit a recipient's authentication method
- Add or modify an expiration date
- Add a Note to the agreement
- Share an individual agreement
- Unshare an agreement
- Download an individual agreement
- Download the individual files of an agreement
- Download the Audit Report of an agreement
- Download the field content of an agreement
- Audit Report
- Reporting and Data exports
- Overview
- Grant users access to reporting
- Report charts
- Data Exports
- Rename a report/export
- Duplicate a report/export
- Schedule a report/export
- Delete a report/export
- Check Transaction Usage
Advanced Agreement Capabilities and Workflows
- Webforms
- Reusable Templates (Library templates)
- Transfer ownership of web forms and library templates
- Power Automate Workflows
- Overview of the Power Automate integration and included entitlements
- Enable the Power Automate integration
- In-Context Actions on the Manage page
- Track Power Automate usage
- Create a new flow (Examples)
- Triggers used for flows
- Importing flows from outside Acrobat Sign
- Manage flows
- Edit flows
- Share flows
- Disable or Enable flows
- Delete flows
- Useful Templates
- Administrator only
- Agreement archival
- Webform agreement archival
- Save completed web form documents to SharePoint Library
- Save completed web form documents to OneDrive for Business
- Save completed documents to Google Drive
- Save completed web form documents to Box
- Agreement data extraction
- Agreement notifications
- Send custom email notifications with your agreement contents and signed agreement
- Get your Adobe Acrobat Sign notifications in a Teams Channel
- Get your Adobe Acrobat Sign notifications in Slack
- Get your Adobe Acrobat Sign notifications in Webex
- Agreement generation
- Generate document from Power App form and Word template, send for signature
- Generate agreement from Word template in OneDrive, and get signature
- Generate agreement for selected Excel row, send for review and signature
- Custom Send workflows
- Share users and agreements
Integrate with other products
- Acrobat Sign integrations overview
- Acrobat Sign for Salesforce
- Acrobat Sign for Microsoft
- Other Integrations
- Partner managed integrations
- How to obtain an integration key
Acrobat Sign Developer
- REST APIs
- Webhooks
Support and Troubleshooting
Configuration options
Configuring the Webhook requires five elements to be defined:
- Name - An intuitive name that other admins can readily understand is suggested.
- Scope - How wide of a net is the webhook catching? Account and Group are available in the interface.
- The API supports Account, Group, User, and Resource scopes.
- Only one Scope per webhook can be defined.
- URL - The target URL that Acrobat Sign pushed the JSON payload to.
- Events - The trigger that causes Acrobat Sign to build the JSON and push it to the URL.
- Each event builds a different payload relevant to the trigger event.
- Multiple Events can be included in one webhook.
- Notification Parameters - The Notification Parameters identify the sections of the Event JSON payload, allowing you to select only the sections of the Event that are important for this webhook (and thus reducing the unnecessary data sent to your URL).
Once the webhook is fully defined, click Save, and the new webhook will start reacting to trigger events immediately.
Please configure your webhook URL to respond to the webhook verification and webhook notification requests as per the verification protocol explained above. The client ID (Application ID) that will be sent to webhooks created from the Acrobat Sign web application will be - UB7E5BXCXY
Scopes
- Account: All the subscribed events occurring in the account trigger the push.
- Account admins have the authority to see all webhooks defined for the account and all groups within that account.
- Group: All the subscribed events occurring in the group trigger the push. NOTE: Group scoped webhooks exist only for that one group.
- Group admins will only see the webhooks that are dedicated to their group. They cannot see the Account level webhooks or webhooks bound to other groups.
- Accounts that have Users in Multiple Groups enabled will see the option to set the group that the scope should be applied to.
- User Account: All subscribed events for a user account trigger the push. User-level webhooks can only be created via API.
- Resource level webhook: This will be created for a specific resource. Events specific to this resource will be pushed to the webhook URL. Resource-level webhooks can only be created via API.
URL
A webhook URL is a server that listens for incoming HTTPS POST notification messages that are triggered when events occur.
You need this URL to subscribe to your webhook to events.
- The client must include an HTTPS URL that Acrobat Sign can POST to. This URL must be available on the public internet.
- For example, 127.0.0.1 and localhost URIs will not work.
- The URL endpoint must be listening on port 443 or 8443 (decided by the customer when defining the callback URL).
- Make sure the webhook supports POST requests for incoming event notifications and GET requests for the verification request.
- The URL should not be blocked by a firewall.
Events
Below are the events that can trigger a push to the webhook URL, grouped by object and listed in the order found in the UI.
The value on the left is the value you will see in the Acrobat Sign UI. The value on the right is the webhook name in the API.
For complete details regarding the webhooks and their payloads, see the Acrobat Sign developers guide.
Agreements:
UI Element | Webhook name |
Agreement all events | AGREEMENT_ALL |
Agreement created | AGREEMENT_CREATED |
Agreement sent | AGREEMENT_ACTION_REQUESTED |
Agreement participant completed | AGREEMENT_ACTION_COMPLETED |
Agreement workflow completed | AGREEMENT_WORKFLOW_COMPLETED |
Agreement expired | AGREEMENT_EXPIRED |
Agreement deleted | AGREEMENT_DOCUMENTS_DELETED |
Agreement canceled | AGREEMENT_RECALLED |
Agreement rejected | AGREEMENT_REJECTED |
Agreement shared | AGREEMENT_SHARED |
Agreement unshared | AGREEMENT_UNSHARE |
Agreement unshared auto | AGREEMENT_UNSHARE_AUTO |
Agreement delegated | AGREEMENT_ACTION_DELEGATED |
Agreement participant replaced | AGREEMENT_ACTION_REPLACED_SIGNER |
Agreement modified | AGREEMENT_MODIFIED |
Agreement modification acknowledged | AGREEMENT_USER_ACK_AGREEMENT_MODIFIED |
Agreement email viewed | AGREEMENT_EMAIL_VIEWED |
Agreement email bounced | AGREEMENT_EMAIL_BOUNCED |
Agreement document viewed | AGREEMENT_DOCUMENTS_VIEWED |
Agreement document viewed when a password has been applied to view the document | AGREEMENT_DOCUMENTS_VIEWED_PASSWORD_PROTECTED |
Agreement creation failed | AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM |
Agreement synced post offline event | AGREEMENT_OFFLINE_SYNC |
Agreement vaulted | AGREEMENT_VAULTED |
Agreement participant social identity authenticated | AGREEMENT_WEB_IDENTITY_AUTHENTICATED |
Agreement participant KBA authenticated | AGREEMENT_KBA_AUTHENTICATED |
Agreement participant Email OTP authenticated |
AGREEMENT_EMAIL_OTP_AUTHENTICATED |
Agreement expiration updated | AGREEMENT_EXPIRATION_UPDATED |
Agreement reminder sent | AGREEMENT_REMINDER_SENT |
Agreement signer name changed by signer | AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER |
Agreement reminder initiated | AGREEMENT_REMINDER_INITIATED |
Agreement Webhooks only available via API | |
UI Element | Webhook name |
NA |
AGREEMENT_READY_TO_NOTARIZE |
NA |
AGREEMENT_READY_TO_VAULT |
Send in Bulk:
UI Element | Webhook name |
Send in Bulk all events | MEGASIGN_ALL |
Send in Bulk created |
MEGASIGN_CREATED |
Send in Bulk shared |
MEGASIGN_SHARED |
Send in Bulk recalled |
MEGASIGN_RECALLED |
Send in Bulk reminder sent | MEGASIGN_REMINDER_SENT |
Send in Bulk reminder initiated | MEGASIGN_REMINDER_INITIATED |
Web Forms:
UI Element | Webhook name |
Web Form all events | WIDGET_ALL |
Web Form created |
WIDGET_CREATED |
Web Form enabled |
WIDGET_ENABLED |
Web Form disabled |
WIDGET_DISABLED |
Web Form modified |
WIDGET_MODIFIED |
Web Form shared |
WIDGET_SHARED |
Web Form creation failed |
WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM |
Library templates (API Only):
UI Element | Webhook name |
NA | LIBRARY_DOCUMENT_ALL |
NA | LIBRARY_DOCUMENT_CREATED |
NA | LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM |
NA | LIBRARY_DOCUMENT_MODIFIED |
Notification Parameters
Notification Parameters allow you to customize the JSON payload to just specific elements of the event.
For example, in an Agreement participant replaced event, you may only want the Agreement Info and the Participant Info, leaving out the Document Info, and reducing the total size of the JSON sent to your webhook URL.
- Agreement
- Agreement Info - Detailed agreement information based on the state of the agreement at the time of the triggering event.
- Agreement Document Info - Includes any document information generated as a result of the event.
- Agreement Participant Info - Includes any participant information as a result of the event.
- Agreement Signed Document - Provides the signed PDF.
- Applicable to the Agreement Workflow Completed and Agreement All events.
- Send in Bulk
- Send in Bulk Info - Detailed information about the Send in Bulk object that triggered the event.
- Web Form
- Widget Info - Detailed information about the web form that triggered the event.
- Widget Document Info - The document information associated with the web form.
- Widget Participant Info - Information about the defined participants in the web form.