KosmoKrator

productivity

Adobe Acrobat Sign Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Adobe Acrobat Sign KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.adobe_acrobat_sign.*. Use lua_read_doc("integrations.adobe-acrobat-sign") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Adobe Acrobat Sign workflow without starting an interactive agent session.

Inline Lua call
kosmo integrations:lua --eval 'dump(app.integrations.adobe_acrobat_sign.creates_agreement_sends_it_out_signatures_and_returns_agreementid_response_client({}))' --json
Read Lua docs headlessly
kosmo integrations:lua --eval 'print(docs.read("adobe-acrobat-sign"))' --json
kosmo integrations:lua --eval 'print(docs.read("adobe-acrobat-sign.creates_agreement_sends_it_out_signatures_and_returns_agreementid_response_client"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua
local adobe_acrobat_sign = app.integrations.adobe_acrobat_sign
local result = adobe_acrobat_sign.creates_agreement_sends_it_out_signatures_and_returns_agreementid_response_client({})

dump(result)
Run the workflow
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.adobe_acrobat_sign, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.adobe_acrobat_sign.default.* or app.integrations.adobe_acrobat_sign.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Adobe Acrobat Sign, use the narrower mcp:lua command.

MCP Lua command
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Adobe Acrobat Sign

Lua namespace: adobe-acrobat-sign

This integration exposes Adobe Acrobat Sign REST v6 operations generated from Adobe’s published Swagger JSON resources. It covers agreements, base URI discovery, groups, library documents, mega signs, transient document uploads, users, webhooks, widgets, and workflows.

Authentication

Configure access_token with an Adobe Acrobat Sign OAuth bearer token that has the scopes required by the operation. Configure api_url to the regional REST v6 base URL for the account, for example https://api.na1.adobesign.com/api/rest/v6. Use adobe_acrobat_sign_base_uris_get_base_uris to discover the correct regional API access point for a token.

Common Workflows

  • Discover base URLs with adobe_acrobat_sign_base_uris_get_base_uris.
  • Create or inspect agreements with adobe_acrobat_sign_agreements_create_agreement, adobe_acrobat_sign_agreements_get_agreement_info, and related document, event, reminder, and state tools.
  • Manage users and groups with the generated adobe_acrobat_sign_users_* and adobe_acrobat_sign_groups_* tools.
  • Create transient upload documents with adobe_acrobat_sign_transient_documents_create_transient_document. The file parameter accepts a local file path or a host-provided upload descriptor.
  • Manage webhooks, widgets, mega signs, library documents, and workflows with their respective generated tool families.

Payload Notes

Most write operations accept a body object matching Adobe’s Swagger model. Header parameters such as x_api_user and x_on_behalf_of_user are exposed when Adobe documents them. The Authorization header is supplied by the integration from access_token, so agents should not pass it as a tool argument.

Raw agent markdown
# Adobe Acrobat Sign

Lua namespace: `adobe-acrobat-sign`

This integration exposes Adobe Acrobat Sign REST v6 operations generated from Adobe's published Swagger JSON resources. It covers agreements, base URI discovery, groups, library documents, mega signs, transient document uploads, users, webhooks, widgets, and workflows.

## Authentication

Configure `access_token` with an Adobe Acrobat Sign OAuth bearer token that has the scopes required by the operation. Configure `api_url` to the regional REST v6 base URL for the account, for example `https://api.na1.adobesign.com/api/rest/v6`. Use `adobe_acrobat_sign_base_uris_get_base_uris` to discover the correct regional API access point for a token.

## Common Workflows

- Discover base URLs with `adobe_acrobat_sign_base_uris_get_base_uris`.
- Create or inspect agreements with `adobe_acrobat_sign_agreements_create_agreement`, `adobe_acrobat_sign_agreements_get_agreement_info`, and related document, event, reminder, and state tools.
- Manage users and groups with the generated `adobe_acrobat_sign_users_*` and `adobe_acrobat_sign_groups_*` tools.
- Create transient upload documents with `adobe_acrobat_sign_transient_documents_create_transient_document`. The file parameter accepts a local file path or a host-provided upload descriptor.
- Manage webhooks, widgets, mega signs, library documents, and workflows with their respective generated tool families.

## Payload Notes

Most write operations accept a `body` object matching Adobe's Swagger model. Header parameters such as `x_api_user` and `x_on_behalf_of_user` are exposed when Adobe documents them. The `Authorization` header is supplied by the integration from `access_token`, so agents should not pass it as a tool argument.
Metadata-derived Lua example
local result = app.integrations.adobe_acrobat_sign.creates_agreement_sends_it_out_signatures_and_returns_agreementid_response_client({})
print(result)

Functions

creates_agreement_sends_it_out_signatures_and_returns_agreementid_response_client Write

This is a primary endpoint which is used to create a new agreement. An agreement can be created using transientDocument, libraryDocument or a URL. You can create an agreement in one of the 3 mentioned states: a) DRAFT - to incrementally build the agreement...

Lua path
app.integrations.adobe_acrobat_sign.creates_agreement_sends_it_out_signatures_and_returns_agreementid_response_client
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_create_agreement
ParameterTypeRequiredDescription
No parameters.
adds_template_fields_agreement Write

Adds template fields to an agreement

Lua path
app.integrations.adobe_acrobat_sign.adds_template_fields_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_add_template_fields_to_agreement
ParameterTypeRequiredDescription
No parameters.
creates_participantset_which_agreement_forwarded_taking_appropriate_action Write

Participants marked as delegator can call this API endpoint.

Lua path
app.integrations.adobe_acrobat_sign.creates_participantset_which_agreement_forwarded_taking_appropriate_action
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_create_delegated_participant_sets
ParameterTypeRequiredDescription
No parameters.
share_agreement_with_someone Write

Share an agreement with someone.

Lua path
app.integrations.adobe_acrobat_sign.share_agreement_with_someone
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_create_share_on_agreement
ParameterTypeRequiredDescription
No parameters.
creates_reminder_specified_participants_agreement_identified_by_agreementid_path Write

Creates a reminder on the specified participants of an agreement identified by agreementId in the path.

Lua path
app.integrations.adobe_acrobat_sign.creates_reminder_specified_participants_agreement_identified_by_agreementid_path
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_create_reminder_on_participant
ParameterTypeRequiredDescription
No parameters.
retrieves_latest_state_view_url_agreement Write

Retrieves the latest state view url of agreement.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_latest_state_view_url_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_create_agreement_view
ParameterTypeRequiredDescription
No parameters.
retrieves_agreements_user Read

Retrieves agreements for the user.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_agreements_user
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_agreements
ParameterTypeRequiredDescription
No parameters.
retrieves_current_status_agreement Read

Retrieves the current status of an agreement.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_current_status_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_agreement_info
ParameterTypeRequiredDescription
No parameters.
retrieves_audit_trail_agreement_identified_by_agreementid Read

PDF file stream containing audit trail information

Lua path
app.integrations.adobe_acrobat_sign.retrieves_audit_trail_agreement_identified_by_agreementid
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_audit_trail
ParameterTypeRequiredDescription
No parameters.
retrieves_single_combined_pdf_document_documents_associated_with_agreement Read

Retrieves a single combined PDF document for the documents associated with an agreement.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_single_combined_pdf_document_documents_associated_with_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_combined_document
ParameterTypeRequiredDescription
No parameters.
retrieves_info_all_pages_combined_pdf_document_documents_associated_with_agreement Read

Retrieves info of all pages of a combined PDF document for the documents associated with an agreement.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_info_all_pages_combined_pdf_document_documents_associated_with_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_combined_document_pages_info
ParameterTypeRequiredDescription
No parameters.
retrieves_ids_documents_agreement_identified_by_agreementid Read

Retrieves the IDs of the documents of an agreement identified by agreementId.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_ids_documents_agreement_identified_by_agreementid
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_all_documents
ParameterTypeRequiredDescription
No parameters.
retrieves_file_stream_document_agreement Read

Retrieves the file stream of a document of an agreement.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_file_stream_document_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_document
ParameterTypeRequiredDescription
No parameters.
retrieves_image_urls_all_visible_pages_document_associated_with_agreement Read

Retrieves image urls of all visible pages of a document associated with an agreement.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_image_urls_all_visible_pages_document_associated_with_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_document_image_urls
ParameterTypeRequiredDescription
No parameters.
retrieves_image_urls_all_visible_pages_all_documents_associated_with_agreement Read

Retrieves image urls of all visible pages of all the documents associated with an agreement.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_image_urls_all_visible_pages_all_documents_associated_with_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_all_documents_image_urls
ParameterTypeRequiredDescription
No parameters.
retrieves_events_information_agreement Read

Retrieves the events information for an agreement.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_events_information_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_events
ParameterTypeRequiredDescription
No parameters.
retrieves_data_entered_into_interactive_form_fields_agreement Read

This API can only be called by the creator of the agreement

Lua path
app.integrations.adobe_acrobat_sign.retrieves_data_entered_into_interactive_form_fields_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_form_data
ParameterTypeRequiredDescription
No parameters.
retrieves_details_form_fields_agreement Read

Retrieves details of form fields of an agreement.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_details_form_fields_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_form_fields
ParameterTypeRequiredDescription
No parameters.
retrieves_merge_info_stored_with_agreement Read

Retrieves the merge info stored with an agreement.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_merge_info_stored_with_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_merge_info
ParameterTypeRequiredDescription
No parameters.
retrieves_latest_note_associated_with_agreement Read

Retrieves the latest note associated with an agreement.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_latest_note_associated_with_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_agreement_note_for_api_user
ParameterTypeRequiredDescription
No parameters.
retrieves_information_members_agreement Read

Retrieves information of members of the agreement.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_information_members_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_all_members
ParameterTypeRequiredDescription
No parameters.
retrieves_participant_set_agreement_identified_by_agreementid_path Read

Retrieves the participant set of an agreement identified by agreementId in the path.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_participant_set_agreement_identified_by_agreementid_path
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_participant_set
ParameterTypeRequiredDescription
No parameters.
retrieves_url_page_current_signer_agreement Read

Retrieves the URL for the e-sign page for the current signer(s) of an agreement.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_url_page_current_signer_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_signing_url
ParameterTypeRequiredDescription
No parameters.
retrieves_reminders_agreement_identified_by_agreementid_path Read

Retrieves the reminders of an agreement, identified by agreementId in the path.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_reminders_agreement_identified_by_agreementid_path
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_get_agreement_reminders
ParameterTypeRequiredDescription
No parameters.
updates_agreement_draft_state Write

Updates the agreement in draft state.

Lua path
app.integrations.adobe_acrobat_sign.updates_agreement_draft_state
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_update_agreement
ParameterTypeRequiredDescription
No parameters.
updates_form_fields_agreement Write

Updates form fields of an agreement.

Lua path
app.integrations.adobe_acrobat_sign.updates_form_fields_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_update_form_fields
ParameterTypeRequiredDescription
No parameters.
set_merge_info_agreement Write

Set the merge info for an agreement.

Lua path
app.integrations.adobe_acrobat_sign.set_merge_info_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_update_agreement_merge_info
ParameterTypeRequiredDescription
No parameters.
updates_visibility_agreement Write

Updates the visibility of an agreement.

Lua path
app.integrations.adobe_acrobat_sign.updates_visibility_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_update_agreement_visibility
ParameterTypeRequiredDescription
No parameters.
updates_participant_set_agreement_identified_by_agreementid_path Write

Updates the participant set of an agreement identified by agreementId in the path.

Lua path
app.integrations.adobe_acrobat_sign.updates_participant_set_agreement_identified_by_agreementid_path
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_update_participant_set
ParameterTypeRequiredDescription
No parameters.
rejects_agreement_participant Write

Rejects the agreement for a participant.

Lua path
app.integrations.adobe_acrobat_sign.rejects_agreement_participant
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_reject_agreement_for_participation
ParameterTypeRequiredDescription
No parameters.
updates_state_agreement_identified_by_agreementid_path Write

This endpoint can be used by originator/sender of an agreement to transition between the states of agreement. An allowed transition would follow the following sequence: DRAFT -> AUTHORING -> IN_PROCESS -> CANCELLED.

Lua path
app.integrations.adobe_acrobat_sign.updates_state_agreement_identified_by_agreementid_path
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_update_agreement_state
ParameterTypeRequiredDescription
No parameters.
deletes_all_documents_agreement Write

Deletes all the documents of an agreement.

Lua path
app.integrations.adobe_acrobat_sign.deletes_all_documents_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_agreements_delete_documents
ParameterTypeRequiredDescription
No parameters.
gets_base_uri_access_other_apis_case_other_apis_are_accessed_from_different_end_point_it_will_consid Read

Gets the base uri to access other APIs. In case other APIs are accessed from a different end point, it will be considered an invalid request.

Lua path
app.integrations.adobe_acrobat_sign.gets_base_uri_access_other_apis_case_other_apis_are_accessed_from_different_end_point_it_will_consid
Full name
adobe-acrobat-sign.adobe_acrobat_sign_base_uris_get_base_uris
ParameterTypeRequiredDescription
No parameters.
retrieves_all_groups_account Read

Retrieves all the groups in an account.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_all_groups_account
Full name
adobe-acrobat-sign.adobe_acrobat_sign_groups_get_groups
ParameterTypeRequiredDescription
No parameters.
retrieves_detailed_information_about_group Read

Retrieves detailed information about the group.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_detailed_information_about_group
Full name
adobe-acrobat-sign.adobe_acrobat_sign_groups_get_group_details
ParameterTypeRequiredDescription
No parameters.
retrieves_all_users_group Read

Retrieves all the users in a group.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_all_users_group
Full name
adobe-acrobat-sign.adobe_acrobat_sign_groups_get_users_in_group
ParameterTypeRequiredDescription
No parameters.
creates_template_that_placed_library_user_reuse Write

Creates a template that is placed in the library of the user for reuse.

Lua path
app.integrations.adobe_acrobat_sign.creates_template_that_placed_library_user_reuse
Full name
adobe-acrobat-sign.adobe_acrobat_sign_library_documents_create_library_document
ParameterTypeRequiredDescription
No parameters.
retrieves_latest_state_view_url_library_document Write

Retrieves the latest state view url of a library document.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_latest_state_view_url_library_document
Full name
adobe-acrobat-sign.adobe_acrobat_sign_library_documents_create_library_document_view
ParameterTypeRequiredDescription
No parameters.
retrieves_library_documents_user Read

Retrieves library documents for a user.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_library_documents_user
Full name
adobe-acrobat-sign.adobe_acrobat_sign_library_documents_get_library_documents
ParameterTypeRequiredDescription
No parameters.
retrieves_details_library_document Read

Retrieves the details of a library document.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_details_library_document
Full name
adobe-acrobat-sign.adobe_acrobat_sign_library_documents_get_library_document_info
ParameterTypeRequiredDescription
No parameters.
retrieves_audit_trail_associated_with_library_document Read

Retrieves the audit trail associated with a library document.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_audit_trail_associated_with_library_document
Full name
adobe-acrobat-sign.adobe_acrobat_sign_library_documents_get_library_document_audit_trail
ParameterTypeRequiredDescription
No parameters.
retrieves_combined_document_associated_with_library_document Read

Retrieves the combined document associated with a library document.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_combined_document_associated_with_library_document
Full name
adobe-acrobat-sign.adobe_acrobat_sign_library_documents_get_combined_document
ParameterTypeRequiredDescription
No parameters.
retrieves_ids_documents_associated_with_library_document Read

Retrieves the IDs of the documents associated with library document.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_ids_documents_associated_with_library_document
Full name
adobe-acrobat-sign.adobe_acrobat_sign_library_documents_get_documents
ParameterTypeRequiredDescription
No parameters.
retrieves_file_stream_document_library_document Read

Retrieves the file stream of a document of library document.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_file_stream_document_library_document
Full name
adobe-acrobat-sign.adobe_acrobat_sign_library_documents_get_library_document
ParameterTypeRequiredDescription
No parameters.
retrieves_image_urls_all_visible_pages_document_associated_with_library_document Read

Retrieves image urls of all visible pages of a document associated with a library document.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_image_urls_all_visible_pages_document_associated_with_library_document
Full name
adobe-acrobat-sign.adobe_acrobat_sign_library_documents_get_library_document_image_urls
ParameterTypeRequiredDescription
No parameters.
retrieves_events_information_library_document Read

Retrieves the events information for a library document.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_events_information_library_document
Full name
adobe-acrobat-sign.adobe_acrobat_sign_library_documents_get_events
ParameterTypeRequiredDescription
No parameters.
retrieves_latest_note_library_document_api_user Read

Retrieves the latest note of a library document for the API user.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_latest_note_library_document_api_user
Full name
adobe-acrobat-sign.adobe_acrobat_sign_library_documents_get_library_document_note_for_api_user
ParameterTypeRequiredDescription
No parameters.
updates_library_document Write

Currently status, name, sharingMode and templateTypes of the library document can only be updated.

Lua path
app.integrations.adobe_acrobat_sign.updates_library_document
Full name
adobe-acrobat-sign.adobe_acrobat_sign_library_documents_update_library_document
ParameterTypeRequiredDescription
No parameters.
updates_visibility_library_document Write

Updates the visibility of library document.

Lua path
app.integrations.adobe_acrobat_sign.updates_visibility_library_document
Full name
adobe-acrobat-sign.adobe_acrobat_sign_library_documents_update_library_document_visibility
ParameterTypeRequiredDescription
No parameters.
updates_library_document_state Write

Currently state can be changed from AUTHORING to ACTIVE.

Lua path
app.integrations.adobe_acrobat_sign.updates_library_document_state
Full name
adobe-acrobat-sign.adobe_acrobat_sign_library_documents_update_library_document_state
ParameterTypeRequiredDescription
No parameters.
send_agreement_out_signature_multiple_recipients_each_recipient_will_receive_and_their_own_copy_th Write

This is a primary endpoint which is used to create a new megaSign. A megaSign can be created using transientDocument, libraryDocument or a URL. You can create a megaSign in IN_PROCESS - Create a megaSign in this state to immediately send it. You can use the...

Lua path
app.integrations.adobe_acrobat_sign.send_agreement_out_signature_multiple_recipients_each_recipient_will_receive_and_their_own_copy_th
Full name
adobe-acrobat-sign.adobe_acrobat_sign_mega_signs_create_mega_sign
ParameterTypeRequiredDescription
No parameters.
retrieves_requested_views_mega_agreement Write

Retrieves the requested views of mega sign agreement.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_requested_views_mega_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_mega_signs_get_mega_sign_view
ParameterTypeRequiredDescription
No parameters.
retrieves_megasign_parent_agreements_user Read

Retrieves MegaSign parent agreements for a user.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_megasign_parent_agreements_user
Full name
adobe-acrobat-sign.adobe_acrobat_sign_mega_signs_get_mega_signs
ParameterTypeRequiredDescription
No parameters.
get_detailed_information_specified_megasign_parent_agreement Read

Get detailed information of the specified MegaSign parent agreement.

Lua path
app.integrations.adobe_acrobat_sign.get_detailed_information_specified_megasign_parent_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_mega_signs_get_mega_sign_info
ParameterTypeRequiredDescription
No parameters.
get_all_child_agreements_specified_megasign_parent_agreement Read

Get all the child agreements of the specified MegaSign parent agreement.

Lua path
app.integrations.adobe_acrobat_sign.get_all_child_agreements_specified_megasign_parent_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_mega_signs_get_mega_sign_child_agreements
ParameterTypeRequiredDescription
No parameters.
retrieves_file_stream_original_childagreementsinfofile_that_was_uploaded_by_sender_while_creating_mega Read

CSV file stream containing form data information

Lua path
app.integrations.adobe_acrobat_sign.retrieves_file_stream_original_childagreementsinfofile_that_was_uploaded_by_sender_while_creating_mega
Full name
adobe-acrobat-sign.adobe_acrobat_sign_mega_signs_get_child_agreements_info_file
ParameterTypeRequiredDescription
No parameters.
retrieves_single_combined_pdf_document_documents_associated_with_megasign_parent_agreement Read

Retrieves a single combined PDF document for the documents associated with the MegaSign parent agreement.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_single_combined_pdf_document_documents_associated_with_megasign_parent_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_mega_signs_get_mega_sign_combined_document
ParameterTypeRequiredDescription
No parameters.
retrieves_events_information_megasign_parent_agreement Read

Retrieves the events information for the MegaSign parent agreement.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_events_information_megasign_parent_agreement
Full name
adobe-acrobat-sign.adobe_acrobat_sign_mega_signs_get_events
ParameterTypeRequiredDescription
No parameters.
retrieves_data_entered_by_recipients_into_interactive_form_fields_time_they_signed_child_agreements Read

CSV file stream containing form data information

Lua path
app.integrations.adobe_acrobat_sign.retrieves_data_entered_by_recipients_into_interactive_form_fields_time_they_signed_child_agreements
Full name
adobe-acrobat-sign.adobe_acrobat_sign_mega_signs_get_mega_sign_form_data
ParameterTypeRequiredDescription
No parameters.
updates_state_megasign_identified_by_megasignid_path Write

This endpoint can be used by creator of the MegaSign to transition between the states of megaSign. An allowed transition would follow the following sequence : IN_PROCESS->CANCELLED.

Lua path
app.integrations.adobe_acrobat_sign.updates_state_megasign_identified_by_megasignid_path
Full name
adobe-acrobat-sign.adobe_acrobat_sign_mega_signs_update_mega_sign_state
ParameterTypeRequiredDescription
No parameters.
uploads_document_and_obtains_document_id Write

The document uploaded through this call is referred to as transient since it is available only for 7 days after the upload. The returned transient document ID can be used in the API calls where the uploaded file needs to be referred. The transient document...

Lua path
app.integrations.adobe_acrobat_sign.uploads_document_and_obtains_document_id
Full name
adobe-acrobat-sign.adobe_acrobat_sign_transient_documents_create_transient_document
ParameterTypeRequiredDescription
No parameters.
retrieves_url_manage_account_settings_and_user_profile_page Write

Retrieves the URL of manage, account settings and user profile page.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_url_manage_account_settings_and_user_profile_page
Full name
adobe-acrobat-sign.adobe_acrobat_sign_users_get_user_views
ParameterTypeRequiredDescription
No parameters.
retrieves_all_users_account Read

Retrieves all the users in an account.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_all_users_account
Full name
adobe-acrobat-sign.adobe_acrobat_sign_users_get_users
ParameterTypeRequiredDescription
No parameters.
retrieves_detailed_information_about_user_caller_account Read

Retrieves detailed information about the user in the caller account.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_detailed_information_about_user_caller_account
Full name
adobe-acrobat-sign.adobe_acrobat_sign_users_get_user_detail
ParameterTypeRequiredDescription
No parameters.
retrieves_groups_user Read

Retrieves the groups of the user.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_groups_user
Full name
adobe-acrobat-sign.adobe_acrobat_sign_users_get_groups_of_user
ParameterTypeRequiredDescription
No parameters.
update_user Write

Update an user.

Lua path
app.integrations.adobe_acrobat_sign.update_user
Full name
adobe-acrobat-sign.adobe_acrobat_sign_users_modify_user
ParameterTypeRequiredDescription
No parameters.
updates_groups_user Write

Updates the groups of the user.

Lua path
app.integrations.adobe_acrobat_sign.updates_groups_user
Full name
adobe-acrobat-sign.adobe_acrobat_sign_users_update_groups_of_user
ParameterTypeRequiredDescription
No parameters.
activate_deactivate_given_user Write

Activate/Deactivate a given user.

Lua path
app.integrations.adobe_acrobat_sign.activate_deactivate_given_user
Full name
adobe-acrobat-sign.adobe_acrobat_sign_users_modify_user_state
ParameterTypeRequiredDescription
No parameters.
creates_webhook Write

Creates a webhook.

Lua path
app.integrations.adobe_acrobat_sign.creates_webhook
Full name
adobe-acrobat-sign.adobe_acrobat_sign_webhooks_create_webhook
ParameterTypeRequiredDescription
No parameters.
retrieves_webhooks_user Read

Retrieves webhooks for a user.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_webhooks_user
Full name
adobe-acrobat-sign.adobe_acrobat_sign_webhooks_get_webhooks
ParameterTypeRequiredDescription
No parameters.
retrieves_details_webhook Read

Retrieves the details of a webhook.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_details_webhook
Full name
adobe-acrobat-sign.adobe_acrobat_sign_webhooks_get_webhook_info
ParameterTypeRequiredDescription
No parameters.
updates_webhook Write

Updates a webhook.

Lua path
app.integrations.adobe_acrobat_sign.updates_webhook
Full name
adobe-acrobat-sign.adobe_acrobat_sign_webhooks_update_webhook
ParameterTypeRequiredDescription
No parameters.
updates_state_webhook_identified_by_webhookid_path Write

Updates the state of a webhook identified by webhookId in the path.

Lua path
app.integrations.adobe_acrobat_sign.updates_state_webhook_identified_by_webhookid_path
Full name
adobe-acrobat-sign.adobe_acrobat_sign_webhooks_update_webhook_state
ParameterTypeRequiredDescription
No parameters.
deletes_webhook Write

Deletes a webhook.

Lua path
app.integrations.adobe_acrobat_sign.deletes_webhook
Full name
adobe-acrobat-sign.adobe_acrobat_sign_webhooks_delete_webhook
ParameterTypeRequiredDescription
No parameters.
creates_widget_and_and_returns_widgetid_response_client Write

This is a primary endpoint which is used to create a new widget. You can create a widget in one of the 3 mentioned states: a) DRAFT - to incrementally build the widget, b) AUTHORING - to add/edit form fields in the widget, c) ACTIVE - to immediately host th...

Lua path
app.integrations.adobe_acrobat_sign.creates_widget_and_and_returns_widgetid_response_client
Full name
adobe-acrobat-sign.adobe_acrobat_sign_widgets_create_widget
ParameterTypeRequiredDescription
No parameters.
retrieves_requested_views_widget Write

Retrieves the requested views for a widget.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_requested_views_widget
Full name
adobe-acrobat-sign.adobe_acrobat_sign_widgets_get_widget_view
ParameterTypeRequiredDescription
No parameters.
retrieves_widgets_user Read

Retrieves widgets for a user.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_widgets_user
Full name
adobe-acrobat-sign.adobe_acrobat_sign_widgets_get_widgets
ParameterTypeRequiredDescription
No parameters.
retrieves_details_widget Read

Retrieves the details of a widget.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_details_widget
Full name
adobe-acrobat-sign.adobe_acrobat_sign_widgets_get_widget_info
ParameterTypeRequiredDescription
No parameters.
retrieves_agreements_widget Read

Retrieves agreements for the widget.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_agreements_widget
Full name
adobe-acrobat-sign.adobe_acrobat_sign_widgets_get_widget_agreements
ParameterTypeRequiredDescription
No parameters.
retrieves_audit_trail_widget_identified_by_widgetid Read

Retrieves the audit trail of a widget identified by widgetId.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_audit_trail_widget_identified_by_widgetid
Full name
adobe-acrobat-sign.adobe_acrobat_sign_widgets_get_widget_audit_trail
ParameterTypeRequiredDescription
No parameters.
retrieves_single_combined_pdf_document_documents_associated_with_widget Read

Retrieves a single combined PDF document for the documents associated with a widget.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_single_combined_pdf_document_documents_associated_with_widget
Full name
adobe-acrobat-sign.adobe_acrobat_sign_widgets_get_widget_combined_document
ParameterTypeRequiredDescription
No parameters.
retrieves_ids_documents_associated_with_widget Read

Retrieves the IDs of the documents associated with widget.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_ids_documents_associated_with_widget
Full name
adobe-acrobat-sign.adobe_acrobat_sign_widgets_get_widget_documents
ParameterTypeRequiredDescription
No parameters.
retrieves_file_stream_document_widget Read

Retrieves the file stream of a document of a widget.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_file_stream_document_widget
Full name
adobe-acrobat-sign.adobe_acrobat_sign_widgets_get_widget_document_info
ParameterTypeRequiredDescription
No parameters.
retrieves_events_information_widget Read

Retrieves the events information for a widget.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_events_information_widget
Full name
adobe-acrobat-sign.adobe_acrobat_sign_widgets_get_events
ParameterTypeRequiredDescription
No parameters.
retrieves_data_entered_by_user_into_interactive_form_fields_time_they_signed_widget Read

CSV file stream containing form data information

Lua path
app.integrations.adobe_acrobat_sign.retrieves_data_entered_by_user_into_interactive_form_fields_time_they_signed_widget
Full name
adobe-acrobat-sign.adobe_acrobat_sign_widgets_get_widget_form_data
ParameterTypeRequiredDescription
No parameters.
retrieves_latest_note_widget_api_user Read

Retrieves the latest note of a widget for the API user.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_latest_note_widget_api_user
Full name
adobe-acrobat-sign.adobe_acrobat_sign_widgets_get_widget_note_for_api_user
ParameterTypeRequiredDescription
No parameters.
retrieves_detailed_member_info_along_with_ids_different_types_participants Read

Retrieves detailed member info along with IDs for different types of participants.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_detailed_member_info_along_with_ids_different_types_participants
Full name
adobe-acrobat-sign.adobe_acrobat_sign_widgets_get_all_widget_members
ParameterTypeRequiredDescription
No parameters.
retrieves_participant_set_widget_identified_by_widgetid_path Read

Retrieves the participant set of a widget identified by widgetId in the path.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_participant_set_widget_identified_by_widgetid_path
Full name
adobe-acrobat-sign.adobe_acrobat_sign_widgets_get_participant_set
ParameterTypeRequiredDescription
No parameters.
updates_widget Write

Updates a widget.

Lua path
app.integrations.adobe_acrobat_sign.updates_widget
Full name
adobe-acrobat-sign.adobe_acrobat_sign_widgets_update_widget
ParameterTypeRequiredDescription
No parameters.
updates_visibility_widget Write

Updates the visibility of widget.

Lua path
app.integrations.adobe_acrobat_sign.updates_visibility_widget
Full name
adobe-acrobat-sign.adobe_acrobat_sign_widgets_update_widget_visibility
ParameterTypeRequiredDescription
No parameters.
updates_state_widget_identified_by_widgetid_path Write

This endpoint can be used by creator of the widget to transition between the states of widget. An allowed transition would follow any of the following sequence : DRAFT->AUTHORING->ACTIVE, ACTIVEINACTIVE, DRAFT->CANCELLED.

Lua path
app.integrations.adobe_acrobat_sign.updates_state_widget_identified_by_widgetid_path
Full name
adobe-acrobat-sign.adobe_acrobat_sign_widgets_update_widget_state
ParameterTypeRequiredDescription
No parameters.
retrieves_workflows_user Read

Retrieves workflows for a user.

Lua path
app.integrations.adobe_acrobat_sign.retrieves_workflows_user
Full name
adobe-acrobat-sign.adobe_acrobat_sign_workflows_get_workflows
ParameterTypeRequiredDescription
No parameters.