API Settings and Logs
API Settings let you configure logging for the EventWorks API and view a log of recent API requests. This is useful for monitoring integrations, debugging issues, and auditing external access to your account.
Getting There
Navigate to Settings > Developer tab. The left-hand menu shows:
- API Settings
- API Logs
API Settings
Getting There
Settings > Developer tab > API SettingsConfigure API Logging
- Toggle Enable API Logging to turn request logging on or off.
- Select the Log Retention period — how long logs are kept before being automatically deleted:
- Click Save.
Note: Enabling API logging records all requests made to the EventWorks API (v2). This includes requests from your own integrations and any third-party tools connected to your account.
---
API Logs
Getting There
Settings > Developer tab > API LogsViewing Logs
The API Logs page displays a searchable, filterable log of all recent API requests. You can review:
- The request URL and HTTP method
- When the request was made
- The response status
- Request and response details
Logs are automatically pruned based on your retention setting. Older logs are permanently deleted.
Tip: Use the API Logs to troubleshoot integration issues. If an external tool reports an error, check the logs to see exactly what request was sent and what response EventWorks returned.
Key Concepts
API v2 — EventWorks provides a RESTful API (version 2) that allows external applications to read and write data. The API uses token-based authentication — each user has an API token visible on their profile page. Logging is opt-in — API logging is disabled by default. Enable it only when you need to monitor or debug API activity, and consider disabling it when not needed to keep your data lean. Retention is automatic — Logs older than your configured retention period are automatically deleted. You don't need to manually clean them up.Frequently Asked Questions
Q: Does enabling API logging affect performance?The impact is minimal. Logging adds a small overhead to each API request, but it's negligible for most usage patterns.
Q: Can I export the API logs?The API log viewer is read-only within EventWorks. For more advanced log analysis, consider using your integration platform's own logging capabilities.
Q: Where do I find my API token?Each user's API token is shown on their user profile page. Only the user themselves (or support users) can view the token.