> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ziplined.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Events

> The six events, the filter keys and the sending interval.

Pick one event per rule, then narrow it with a filter.

## The six events

| Event | Envelope `type` | Fires when |
| - | - | - |
| `new_engagement` | `engagement.created` | Someone liked, commented or shared |
| `new_post` | `content.published` | A tracked source published a post |
| `new_qualified_lead` | `lead.qualified` | Someone qualified inside an audience |
| `run_completed` | `run.completed` | A background run finished |
| `account_marked` | `account.marked` | An account was marked |
| `account_mark_revoked` | `account.mark_revoked` | That mark was taken away |

> [!NOTE]
>
> `new_qualified_lead` requires an `audience_id` on the rule. The other five do not.

## The filter

```json theme={null}
{
  "filter": {
    "min_warmth_tier": "warm",
    "engagement_type": ["comment"],
    "first_engagement_only": true
  }
}
```

Every key is optional and all of them are ANDed. An unknown key is a 400, never a silently
ignored condition.

| Key | Applies to | Values |
| - | - | - |
| `min_fit_score` | people | 0 to 100 |
| `min_fit_tier` | people | `none`, `low`, `medium`, `high` |
| `min_warmth` | people | 0 to 100 |
| `min_warmth_tier` | people | `cold`, `cool`, `warm`, `hot` |
| `company_id` | people | a list of company ids |
| `pinned_only` | people | `true` only |
| `engagement_type` | `new_engagement` | `like`, `comment`, `share` |
| `via_kind` | `new_engagement` | `team`, `competitor`, `influencer`, `market` |
| `first_engagement_only` | `new_engagement` | `true` only |
| `orbit` | `new_post` | `team`, `competitor`, `influencer`, `market` |
| `kind`, `status` | `new_post` | post kinds and statuses |

## The interval

```json theme={null}
{ "min_interval_minutes": 1440, "send_hour_utc": 8 }
```

`min_interval_minutes` is one of three presets. `0` sends immediately, `60` batches to at
most one message an hour, `1440` batches to one a day.

At `1440`, `send_hour_utc` sets the whole UTC hour after which the daily message may go out.

> [accordion] Pausing a rule
>
> Pause a rule with `PATCH /v1/integrations/{id}/rules/{rule_id}` and `{ "is_active": false }`.
>
> It keeps its cursor and watermark. A rule that was off for a week does not deliver that week
> when you turn it back on.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.