Skip to content

[CHA-1598] EP: document the new user_type filter #1080

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[CHA-1598] EP: document the new user_type filter #1080

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions content/event-platform/available-filters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,19 @@ Filters events based on the user.
Useful for ignoring updates from designated user like job automation.
:::

### User Type
Filters events based on the user type.

**Type:** Field Match
**Syntax:** `user_type="<user_type>"`
**Parameter:** type string of the user who triggered the event.
**Example:** `user_type="api"` Possible values are `user`, `api`, `job`, `system`, and `unknown-user-type`
**Supported Events:** All event types ([list](/event-platform/available-events.html))

::: tips
Useful for ignoring updates from jobs.
:::

---

### Attribute
Expand Down