Adobe Sign Tables
The Adobe Sign integration uses the following tables
Tables
AdobeSignAgreementInfos
The AdobeSignAgreementInfos table stores metadata related to Adobe Sign agreements, capturing essential details about each agreement, its sender, status, reminders, visibility settings, and document retention policies. This table is designed to facilitate tracking and managing digital agreements within the system, ensuring compliance and visibility into agreement lifecycle events.
| Name | Type | Description |
|---|---|---|
| AuditTrail | string | Stores the audit trail data for the agreement. |
| BatchDate | datetime | The date and time data was synced to our database. |
| CanEditAgreementSettings | bit | If false, the user is not allowed to modify any agreement settings (defaults to true). |
| CanEditElectronicSeals | bit | If false, the user is not allowed to modify electronic seals (defaults to true). |
| CanEditFiles | bit | If false, the user is not permitted to modify the set of files being sent out for signature (defaults to true). |
| Ccs | string | A list of one or more CCs copied in the agreement transaction. CCs receive an email at the beginning of the transaction and also when the final document is signed. |
| ConfigID | integer | The ID of the configuration within Compyl. |
| CreatedDate | datetime | The date when the agreement was created. This is a server-generated attribute and cannot be provided in POST/PUT calls. Format: yyyy-MM-dd'T'HH:mm:ssZ. |
| FirstReminderDelay | integer | Specifies the delay in hours before sending the first reminder. Minimum value: 1 hour. Maximum value: difference between agreement creation and expiry time in hours. |
| GroupID | string | The unique identifier of the group to which the agreement belongs. If not provided during agreement creation, the primary group of the creator will be used. |
| HasFormFieldData | bit | true if form field data is present in the agreement. |
| HasSignerIdentityReport | bit | true if the agreement has a signer identity report available. |
AdobeSignAgreementParticipantSets
This table stores information about participant sets in Adobe Sign agreements. A participant set represents one or more individuals who assume a specific role (e.g., Signer, Approver) in an agreement. The set may consist of multiple participants, but any action taken by one member applies to the entire set.
| Name | Type | Description |
|---|---|---|
| AgreementID | string | The unique identifier of the agreement that this participant set belongs to. |
| BatchDate | datetime | The date and time data was synced to our database. |
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | The unique identifier of the participant set within the Adobe Sign system. |
| Order | integer | The signing order for the participant set. A lower value means the participant set is expected to act earlier in the signing process. |
| Role | string | The role of the participant set in the agreement. Possible values: SIGNER (Signer), APPROVER (Approver), ACCEPTOR (Acceptor), CERTIFIED_RECIPIENT (Certified recipient), FORM_FILLER (Fills forms), DELEGATE_TO_SIGNER (Delegates signing), DELEGATE_TO_APPROVER (Delegates approval), DELEGATE_TO_ACCEPTOR (Delegates acceptance), DELEGATE_TO_CERTIFIED_RECIPIENT (Delegates receipt), DELEGATE_TO_FORM_FILLER (Delegates form filling), NOTARY_SIGNER (Notary verifies signature), ELECTRONIC_SEALER (Applies electronic seal). |
AdobeSignAgreements
This table represents the collection of user agreements.
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| DisplayDate | datetime | The display date for the agreement in UTC format (yyyy-MM-dd'T'HH:mm:ssZ). |
| GroupID | string | The unique identifier of the group the agreement belongs to. |
| ID | string | The unique identifier of the agreement. |
| IsEsign | bit | True if this is an e-sign document. |
| IsHidden | bit | Determines whether the agreement is hidden from standard views. Possibly related to document visibility settings. |
| LatestVersionID | string | The unique version ID of the latest version of the agreement. |
| Name | string | The name of the agreement. |
| Status | string | The detailed status of the agreement with respect to the API caller. Possible values include WAITING_FOR_MY_SIGNATURE, SIGNED, APPROVED, etc. |
| Type | string | The kind of agreement. Possible values: AGREEMENT, MEGASIGN_CHILD, WIDGET_INSTANCE. |
| UserSetMemberInfos | string | A list containing user set information relevant to the agreement. |
AdobeSignAgreementSetMemberInfos
This table stores information about individual participants (members) in an Adobe Sign agreement. Each record represents a participant set member with details about their identity and authentication method.
| Name | Type | Description |
|---|---|---|
| AgreementID | string | The unique identifier of the agreement to which this participant is associated. This links the participant to a specific Adobe Sign agreement. |
| AuthenticationMethod | string | The method used to authenticate the participant before allowing them to sign the document. Possible values: NONE, PASSWORD, PHONE, KBA, WEB_IDENTITY, ADOBE_SIGN, GOV_ID, DIG_ID, EMAIL_OTP. |
| BatchDate | datetime | The date and time data was synced to our database. |
| ConfigID | integer | The ID of the configuration within Compyl. |
| string | Email of the participant. | |
| ID | string | The unique identifier for the agreement participant. |
| Name | string | The full name of the participant. |
| ParticipantSetID | string | The unique identifier of the participant set to which this participant belongs. |
AdobeSignDocuments
This table stores metadata about documents associated with Adobe Sign agreements. Each record represents a document that is part of an agreement, including its unique identifier, name, file type, page count, and creation date.
| Name | Type | Description |
|---|---|---|
| AdobeSignAgreementConfigID | integer | The ID of the configuration within Compyl. |
| AdobeSignAgreementID | string | The unique identifier of the document within Adobe Sign. |
| BatchDate | datetime | The date and time data was synced to our database. |
| ConfigID | integer | The ID of the configuration within Compyl. |
| CreatedDate | datetime | The date and time when the document was created in Adobe Sign. |
| ID | string | The unique identifier of the document within Adobe Sign. |
| MimeType | string | The MIME type of the document. |
| Name | string | The name of the document, as specified in Adobe Sign. |
| NumPages | integer | The number of pages in the document. |
AdobeSignGroupUsers
This table stores information about Adobe Sign user groups, their membership details, and settings.
| Name | Type | Description |
|---|---|---|
| BatchDate | datetime | The date and time data was synced to our database. |
| ConfigID | integer | The ID of the configuration within Compyl. |
| CreatedDate | datetime | The date when the user group was created. |
| ID | string | Unique identifier of the Adobe Sign group. |
| IsGroupAdmin | bit | Indicates whether the user is an administrator of the group (true if the user has admin privileges). |
| IsPrimaryGroup | bit | Indicates whether the group is the user's primary group. |
| Name | string | Name of the group |
| Status | string | The status of the user’s membership in the group. Allowed values: ACTIVE, DELETED. |
| UserID | string | Unique identifier of the user associated with the group. |
AdobeSignIntegrations
Table contains 0+ configurations a customer may have. (Don't think this table needs to be/should be on Readme)
| Name | Type | Description |
|---|---|---|
| BaseURL | string | Base URL used for calling the Salesforce API |
| CreatedBy | string | Email address of the user who created the integration configuration. |
| CreatedDate | datetime | The date and time the integration configuration was created. |
| ID | integer | Unique identifier for the integration configuration. |
| IsEnabled | bit | Whether this integration configuration is enabled or not. |
| ModifiedBy | string | Email address of the user who modified the integration configuration. |
| ModifiedDate | datetime | The date and time the integration configuration was updated. |
| Name | string | Name of the configuration. |
AdobeSignUserEvents
This table stores records of user events in Adobe Sign, capturing various actions related to user accounts and group memberships.
| Name | Type | Description |
|---|---|---|
| AdminUserId | string | The ID of the account administrator associated with the event. |
| BatchDate | datetime | The date and time data was synced to our database. |
| ConfigID | integer | The ID of the configuration within Compyl. |
| Date | datetime | The date and time when the user event occurred. Format: yyyy-MM-dd'T'HH:mm:ssZ (UTC). |
| Event | string | The type of event that occurred. Possible values include: CREATED, REGISTERED, CHANGE_EMAIL, PASSWORD_RESET, USER_ADDED_TO_GROUP, LOGO_UPLOADED, LOGIN, etc. |
| FromGroupId | string | The identifier of the group from which the user was moved (if applicable). |
| ParticipationId | string | The identifier for the user's participation in the event. |
| ToGroupId | string | The identifier of the group to which the user was moved (if applicable). |
| UserEventId | string | The unique identifier for the event record. |
| UserId | string | The unique identifier of the user associated with the event. |
AdobeSignUsers
The AdobeSignUsers table stores user-related information from Adobe Sign. It contains details about users within an Adobe Sign account, including their identity, account type, status, and administrative privileges. This table is primarily used for tracking user profiles and their associated metadata as retrieved from the Adobe Sign API.
| Name | Type | Description |
|---|---|---|
| AccountId | string | The account ID of the user. |
| AccountType | string | Type of account to which the user belongs. Possible values: FREE, PRO, TEAM, TEAM_TRIAL, ENTERPRISE, ENTERPRISE_TRIAL, GLOBAL, GLOBAL_TRIAL. |
| BatchDate | datetime | The date and time data was synced to our database. |
| Company | string | The name of the company the user belongs to. |
| ConfigID | integer | The ID of the configuration within Compyl. |
| CreatedDate | datetime | The date when the user was created. |
| string | The email address of the user. | |
| FirstName | string | The first name of the user. |
| ID | string | A unique identifier of the user. |
| Initials | string | The initials of the user. |
| IsAccountAdmin | bit | Indicates whether the user is an account admin. |
| LastName | string | The last name of the user. |
| Locale | string | The UI locale of the user. |
| Phone | string | The phone number of the user. |
| PrimaryGroupId | string | The primary group in which the user is added. Default is the account’s default group. |
| Status | string | The status of the user. Possible values: ACTIVE, INACTIVE, CREATED, UNVERIFIED. |
| Title | string | The job title of the user. |
AdobeSignUserSettings
This table stores user-specific settings related to Adobe Sign, including configuration values that determine their permissions and behaviors within the system.
| Name | Type | Description |
|---|---|---|
| AdobeSignGroupUserModelConfigID | integer | The ID of the configuration within Compyl. |
| AdobeSignGroupUserModelID | string | The unique identifier of the Adobe Sign group the user belongs to. |
| AdobeSignGroupUserModelUserID | string | The unique identifier of the user associated with this setting |
| BatchDate | datetime | The date and time data was synced to our database. |
| ConfigID | integer | The ID of the configuration within Compyl. |
| GroupID | string | The unique identifier of the Adobe Sign group the user belongs to. |
| ID | integer | Unique identifier for the user setting. |
| Inherited | bit | Indicates whether the setting is inherited from the user’s group or account. |
| Name | string | The name of the user setting. Corresponds to different setting categories in Adobe Sign (e.g., userCanSend, widgetCreationVisible). |
| UserID | string | The unique identifier of the user associated with this setting |
| Value | bit | The actual value of the setting (e.g., true if the feature is enabled for the user, false otherwise). |
AdobeSignWebhooks
This table stores configuration details for Adobe Sign webhook integrations, including subscribed event types, delivery settings, and metadata options that control the scope and content of event notifications sent to the system.
| Name | Type | Description |
|---|---|---|
| WebhookUrlInfo | string | The endpoint URL that Adobe Sign will call when subscribed events occur |
| Created | datetime | Timestamp indicating when the webhook subscription was created |
| WebhookSubscriptionEvents | string | List of events (e.g., agreement signed, widget completed) that trigger the webhook |
| ApplicationDisplayName | string | Friendly display name of the application that created the webhook |
| ProblemNotificationEmails | string | Email addresses to receive error notifications if webhook delivery fails |
| Scope | string | Defines the entity scope of the webhook (e.g., ACCOUNT, USER) |
| LastModified | datetime | Timestamp of the most recent update to the webhook configuration |
| State | string | Indicates the state of the webhook (e.g., ACTIVE, INACTIVE) |
| ApplicationName | string | Internal name or identifier of the application managing the webhook |
| ResourceType | string | Type of Adobe Sign resource the webhook is subscribed to (e.g., agreement, widget) |
| Status | string | Operational status of the webhook (e.g., enabled, disabled) |
| WidgetEventsIncludeDetailedInfo | bit | Whether widget events include full event metadata |
Updated 11 months ago