Overview

Logs help you understand what happened to a document or an API call inside QuicklySign.

They are primarily used for debugging, support investigations, and tracing document processing inside the system.

There are two primary categories:

• Document Logs – Shows what happened to a specific document inside the QuicklySign backend.
• Request & Response Logs – Shows the API requests your system sent and the responses returned by QuicklySign.

These logs are diagnostic tools only and do not affect the document itself.

Document Logs

Document logs are used to determine what happened to a document during internal processing inside QuicklySign.

This is useful when debugging issues such as:

• Documents appearing stuck during processing
• Investigating PDF generation
• Checking whether documents were queued correctly
• Verifying when a document became ready for signing

Endpoint

GET /v1/document_logs/<document_key>

This endpoint returns a list of document processing logs associated with the specified document.

What You Receive

Each log entry represents a backend processing event.

Fields returned include:

Example Response

{
  "data": {
    "document_logs": [
      {
        "_id": 5730162692325376,
        "date_created": 1659513665796.916015625,
        "document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
        "key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJCCxILRG9jdW1lbnRMb2ciGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMCxILRG9jdW1lbnRMb2cYgICgvtfxlgoMogEHc2FuZGJveA",
        "log_type": "pdf_generation_info",
        "messages": [
          "enqueuing child documents for pdf creation"
        ]
      },
      {
        "_id": 6715648239992832,
        "date_created": 1659513665747.5532226562,
        "document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
        "key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJCCxILRG9jdW1lbnRMb2ciGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMCxILRG9jdW1lbnRMb2cYgICgnov79gsMogEHc2FuZGJveA",
        "log_type": "pdf_generation_info",
        "messages": [
          "Attempting to create final pdf"
        ]
      },
      {
        "_id": 5082482966265856,
        "date_created": 1659513094676.701171875,
        "document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
        "key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJCCxILRG9jdW1lbnRMb2ciGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMCxILRG9jdW1lbnRMb2cYgICgvtzPgwkMogEHc2FuZGJveA",
        "log_type": "check_ready_for_signatures",
        "messages": []
      }
    ]
  },
  "status": {
    "status_code": 200
  }
}

Request & Response Logs

Request and Response Logs help you debug API communication between your system and QuicklySign.

These logs show:

• The API requests sent by your system
• The responses returned by QuicklySign
• Any errors that occurred during processing

This is useful when:

• Your API request returns a 400 or 500 error
• You need to confirm whether a request reached QuicklySign
• You want to inspect request payloads during integration testing
• QuicklySign support asks for request logs during troubleshooting

Endpoint

GET /v1/request_response_logs?client_id=<your_client_id>&client_secret=<your_client_secret>

What It Returns

This endpoint returns a list of recent API requests along with their corresponding responses.

Returned data may include:

• Request path
• Request body
• Response status
• Response body
• Timestamps

The exact schema may vary depending on the request type.

Event Hook Logs

Event Hook Logs allow you to inspect automated callback and rule-engine activity triggered for a document pack.

These logs help determine:

• Which automated actions were triggered
• Whether they executed successfully
• What parameters were passed to the action
• If any errors occurred

Event Hook Logs are especially useful when debugging integrations such as posting notes to Xplan or triggering downstream systems.

There are two related endpoints:

Both endpoints require an entity_key, which is typically the document pack key.

Get Event Hooks

Retrieves the event hook subscriptions currently configured for an entity.

These subscriptions define which actions should occur when certain events happen, such as:

• final_document_generated
• signer_completed
• document_pack_created
• document_pack_cancelled

If no subscriptions exist for the entity, an empty list will be returned.

Endpoint

GET /v1/event_hooks?entity_key=<document_pack_key>&client_id=<client_id>&client_secret=<client_secret>

Example Response

{
  "data": {
    "event_hooks": []
  },
  "status": {
    "status_code": 200
  }
}

Event Hook Run Logs

This endpoint shows the execution history of event hook actions.

It allows you to inspect:

• Which rule engine actions were triggered
• Execution progress (queued, running, complete)
• Parameters used during execution
• Any failures or error messages

This endpoint shows the internal processing steps of the rule engine, not the webhook payload itself.

Endpoint

GET /v1/event_hook_run_logs?entity_key=<document_pack_key>&client_id=<client_id>&client_secret=<client_secret>

Example Response

{
  "data": {
    "event_hook_run_logs": [
      {
        "action": "rule_engine_actions.integration_actions:post_document_note_to_xplan_on_completion",
        "date_created": 1764227429886.096,
        "entity_keys": [
          "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQi..."
        ],
        "event": "final_document_generated",
        "message": "",
        "organisation_key": null,
        "parameters": {
          "document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQi...",
          "rule_engine_event_subscription_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQi..."
        },
        "rule_engine_event_subscription_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQi...",
        "run_log_event": "complete",
        "user_defined_parameters": {}
      }
    ]
  },
  "status": {
    "status_code": 200
  }
}

Run Log Parameter Details