Viimati uuendatud
1. juuli 2024
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.
Märkus.
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.
