/rules

Lists your rules, newest first, 50 at most per page. A rule watches for an event in Mixmax, such as a message being received, checks it against an optional filter, and then runs its actions, such as posting to your webhook. Rules are also managed in the Mixmax app under Rules.

Workspace admins can list a teammate's rules with owner. Rules created under Settings > API for the call webhooks are listed too, but they cannot be changed here.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Pass actions to include each rule's actions in an actions array.

Allowed:
string

The _id of a teammate whose rules to list. Only workspace admins can pass another user's id; anyone else gets 403. Defaults to you.

boolean

Pass false to leave out rules hidden in the Mixmax app. They are included by default.

integer
≤ 50

How many rules to return per page. The maximum, and the default, is 50.

string

The next cursor from the previous page.

string

The previous cursor from the next page.

Responses

403

owner is another user and you are not an admin of their workspace.

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
Psst... like working with APIs? Come join us!