📖 Table of contents
What are API & Webhook logs?
API and Webhook logs work like a technical activity journal. They record the exchanges between your system and Yousign, including:
API calls sent to Yousign
Webhooks sent from Yousign to your system
Request and response details
Status of each event (success or error)
They are essential for developers to:
Investigate errors
Understand unexpected behavior
Debug integrations more independently
How to access API & Webhook logs
You can access logs in two ways:
From the main navigation
In the left sidebar, click on Developers.
You will be able to access API Keys and Webhooks.
Directly from a Signature Request
If you are investigating a specific Signature Request:
Open the Signature Request details page.
Click the three dots menu (⋯).
You’ll see the following options:
See API call logs
See Webhooks logs
See webhooks
You’ll be redirected to the Logs page with an automatic filter applied to that Signature Request, a big time-saver when troubleshooting.
Understand log retention (by plan)
Logs are stored for a limited time depending on your subscription plan:
Plan | Log retention duration |
Plus | 1 day |
Pro | 7 days |
Scale | 30 days |
API Trial | 7 days |
After this period, logs are permanently deleted and can no longer be accessed.
If you regularly investigate issues several days after they occur, your log retention period may impact your ability to troubleshoot.
Search and filter logs efficiently
The Logs page can contain a large number of events. Filters help you quickly find the one you need.
At the top of the page, you can choose to view:
API calls
Webhooks sent
Then use Filters to narrow your search. You can filter by:
🔎 Signature Request ID
Search logs linked to a specific Signature Request ID, especially useful when many logs are generated every second.
⏱ Time range
Filter logs using a precise time range, not just a date.
This makes it much easier to locate an event that happened at a specific moment.
📌 Status Code
Filter by status to quickly identify failed or successful calls.
🔑 API key (API logs only)
If you use multiple API keys, you can filter logs by API key to see only the calls made with a specific one.
Click “Apply” to activate your filters.
What is recorded in the logs?
The logs provide detailed technical information, including:
All API calls, including GET requests (such as retrieving Signature Requests or signer information)
Webhook events sent by Yousign
Request and response bodies
Requests and responses using multipart/form-data (for example, when uploading documents) are also stored, allowing you to see the full technical exchange.
View log details
To see full details:
Click on an API call or webhook from the list.
A side panel opens with the technical details.
You can expand this panel to full page for easier reading when reviewing complex payloads.
Need help investigating an issue?
If the logs don’t clearly explain what happened, our team can help you investigate further.
You can contact us directly from the app:
Click the Help button on the left side of the screen (just above Settings).
Choose Share feedback & contact us.
To help us analyze the issue faster, include:
The Signature Request ID (if relevant)
The approximate date and time of the issue
Whether the API call or webhook shows an error or success status
Any relevant error message visible in the logs
Providing these technical details allows our team to investigate more efficiently.