The Logs page provides a log of all your API and Webhook calls. Click an individual call to view the details of that call and troubleshoot your integration.
Logs can be used during your development cycle to review all API and Webhook calls for both successful and unsuccessful requests over time, and are helpful for seeing which calls dropped and why.
API Logs
To search for a specific call, enter a Resource ID for the call. This ID may be the unique `id` for the Candidate, Report, or Invitation used in the call. In the search results, click the call to open a detailed view.
Click Share this to generate a shareable URL for the specific results displayed on the page.
API Logs provide:
- Summary (Timestamp, IP Address, API URL called, method used, status of the call, Content-Type, and User-Agent)
- Request Query Parameters
- Raw Request Body
- Parsed Request Body
- Response Body
Webhook Logs
This page displays all webhook logs originating from your account's API key.
To search for a specific webhook event, enter a Report ID for the event. In the search results, click the event to open a detailed view.
Click Share this to generate a shareable URL for the specific results displayed on the page.
Webhook Logs provide:
- Summary (timestamp, Webhook URL, Status, and Retry number, if applicable)
- Raw Request Body
- Response Body
Note: API logs are not generated for Partner integrations or other OAuth accounts.
Comments
0 comments
Article is closed for comments.