---
title: "Try a webhook filter"
locale: en
url: https://tlg.builera.app/en/docs/reference/rest/webhooks.preview_filter
verified: 2026-10-24
app_version: "2.0"
generated: true
---

# Try a webhook filter

Would this filter pass this event? Give filters + eventType and either a sample payload or a real eventId (evt_…, last 30 days). Returns match, the reason when not, and the filters sentence.

Would this filter pass this event? Give filters + eventType and either a sample payload or a real eventId (evt_…, last 30 days). Returns match, the reason when not, and the filters sentence.

## Overview

| Name | Value |
| --- | --- |
| Code | `webhooks.preview_filter` |
| Scope needed | `webhooks.read` |
| Risk | Read |
| May need confirmation | No |
| Runs as | Answers right away |
| Needs `Idempotency-Key` | No |
| Member roles allowed | `owner`, `manager`, `agent` |
| In the app | Settings → Webhooks |

## Input fields

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `filters` | `object` | No |   |
| `eventType` | `text` | Yes |   |
| `sample` | `object` | No |   |
| `eventId` | `text` | No |   |
| `webhookId` | `uuid` | No |   |

## Example request

```bash
curl -X POST https://tlg.builera.app/api/public/v2/ops/webhooks.preview_filter \
  -H "Authorization: Bearer $TELEGRAM_AUTO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"eventType":"…"}'
```

## Output fields (`data`)

| Field | Type | Required |
| --- | --- | --- |
| `ok` | `true` | Yes |
| `match` | `true/false` | Yes |
| `reason` | `null \| text` | Yes |
| `reason_text` | `null \| text` | Yes |
| `filters_text` | `text` | Yes |
| `applicable_filters` | `"direction" \| "keywords" \| "chat_types" \| "mention_only" \| "exclude_self" \| "exclude_sent_by" \| "exclude_connection_ids" \| "exclude_own_connection" \| "include_backfill" \| "conversation_ids" \| "conversation_tags" \| "has_media" \| "person_stage_ids" \| "campaign_ids"[]` | Yes |

## Example answer

```json
{
  "data": {
    "ok": true,
    "match": true,
    "reason": "text",
    "reason_text": "text",
    "filters_text": "text",
    "applicable_filters": [
      "direction"
    ]
  }
}
```

## Using it over MCP

Not listed on any profile: call `tools_describe` then `tools_run` with `code: "webhooks.preview_filter"`. Tool name when listed: `webhooks_preview_filter`.