Rules

Rules allow you to filter events, or apply re-labeling. Rules are evaluated in the order of which they are specified in. The rule-evaluation stops after the event matches the first rule.

Relabel Rules

The rule below matches if the Title of your calendar event contains the string 1:1 and then sets the display message to 1:1 as well as marking the event as important

rules:
  - name: "1:1s"
    key: "title"
    contains:
      - "1:1"
    relabelConfig:
      message: "1:1"
      important: true

Skip rules

If a rule specifies skip: true then each calendar event that matches this rule is excluded from the API responses. Below are examples to skip all day and non-blocking events:

rules:
  - name: "Skip all day events"
    key: "all_day"
    contains:
      - "true"
    skip: true

  - name: "Skip non-blocking events"
    key: "busy"
    contains:
      - "Free"
    skip: true

Wildcard Rules matching

You can use * as a wildcard to match everything. If key uses the wildcard, it will search all fields. This is useful for catch-all rules that allow all other events that did not match previous rules to be included in the API responses.

rules:
  - name: "Allow everything else"
    key: "*"
    important: false
    contains:
      - "*"