Skip to content

Commit

Permalink
docs: add audit log section (#58)
Browse files Browse the repository at this point in the history
* docs: add audit log section

* docs: adjust docs for audit logs

* feat: add audit log table img

---------

Co-authored-by: Sebastian Sauerer <[email protected]>
  • Loading branch information
boringContributor and Sebastian Sauerer authored Nov 15, 2024
1 parent 445232c commit 5537319
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions docs/audit-logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
sidebar_position: 14
---

# Audit logs

[[API Docs](/api/audit-logs)]
[[SDK](https://www.npmjs.com/package/@epilot/audit-logs-client)]

Audit logs are a record of all the events which modified resources in your account. This includes changes to entities, automations, webhooks, and more. The audit logs are immutable and can be accessed by admin users in the epilot portal.


:::info

Audit logs are a pricing feature for enterprise tiers. Contact our sales team to learn more about the pricing.

:::

![Audit log table](../static/img/audit-log-table.png)

## Permission
To access the audit logs, you need to have the `audit_log:view` permission. This permission is only available to admin users or as a dedicated permission, which can be assigned to any user in the access management.

## Services being audited
As epilot covers a variety of services, the audit logging is added incrementally. The following services are currently being audited. Contact our support team if you need audit logs for a service not listed here.


| Service | |
|---------- |---------- |
| Entity ||
| Workflow ||
| Webhook ||
| Automation||
| Journey ||
| User ||
| Permission ||
| Blueprint ||
| Messaging ||


## Facade apis
Our generic entity api is audited. More specific wrappers for this apis (facade apis) are not audited to avoid duplication.
Binary file added static/img/audit-log-table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5537319

Please sign in to comment.