---
title: "Webhook details"
locale: en
url: https://tlg.builera.app/en/docs/reference/rest/webhooks.get
verified: 2026-10-24
app_version: "2.0"
generated: true
---

# Webhook details

Full configuration, revision (send it back as expectedRevision when updating), signing keys (kid, expiry — never the secret), filters sentence, effective scope (types / accounts / masked fields actually delivered). revealUrl=true returns the full URL (audited).

Full configuration, revision (send it back as expectedRevision when updating), signing keys (kid, expiry — never the secret), filters sentence, effective scope (types / accounts / masked fields actually delivered). revealUrl=true returns the full URL (audited).

## Overview

| Name | Value |
| --- | --- |
| Code | `webhooks.get` |
| 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 |
| --- | --- | --- | --- |
| `id` | `uuid` | Yes |   |
| `revealUrl` | `true/false` | No | Return the full URL (owner only; audited). |

## Example request

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

## Output fields (`data`)

| Field | Type | Required |
| --- | --- | --- |
| `ok` | `true` | Yes |
| `webhook` | `object` | Yes |

## Example answer

```json
{
  "data": {
    "ok": true,
    "webhook": {
      "keys": [
        {
          "kid": "text",
          "created_at": "2026-10-22T12:00:00.000Z",
          "expires_at": "2026-10-22T12:00:00.000Z",
          "revoked_at": "2026-10-22T12:00:00.000Z",
          "active": true
        }
      ],
      "health_24h": {
        "endpoint_id": "00000000-0000-4000-8000-000000000000",
        "delivered": 1,
        "failed": 1,
        "filtered": 1,
        "pending": 1,
        "dead": 1
      },
      "stats_24h": {
        "hours": [
          {
            "at": "text",
            "ok": 1,
            "failed": 1
          }
        ],
        "attempts": 1,
        "ok": 1,
        "p95_ms": 1,
        "p50_ms": 1
      },
      "last_replay": {
        "id": "00000000-0000-4000-8000-000000000000",
        "status": "text",
        "from_at": "2026-10-22T12:00:00.000Z",
        "to_at": "2026-10-22T12:00:00.000Z",
        "event_types": [
          "text"
        ],
        "only_failed": true,
        "total": 1,
        "enqueued": 1,
        "created_at": "2026-10-22T12:00:00.000Z",
        "finished_at": "2026-10-22T12:00:00.000Z"
      },
      "history": [
        {
          "at": "text",
          "action": "text",
          "by": "connection",
          "actor_id": "00000000-0000-4000-8000-000000000000",
          "changed": [
            "text"
          ],
          "revision": 1
        }
      ],
      "effective": {
        "ok": true,
        "types": [
          "text"
        ],
        "account_ids": [
          "text"
        ],
        "all_accounts": true,
        "masked_fields": [
          "text"
        ]
      },
      "applicable_filters": [
        "direction"
      ],
      "url_host": "text",
      "status": "active",
      "status_reason": "text",
      "status_changed_at": "2026-10-22T12:00:00.000Z",
      "owner": {
        "kind": "human",
        "user_id": "00000000-0000-4000-8000-000000000000",
        "connection_id": "00000000-0000-4000-8000-000000000000",
        "connection_name": "text"
      },
      "event_types": [
        "text"
      ],
      "account_scope": {
        "mode": "all"
      },
      "filters": {
        "direction": "in",
        "keywords": {
          "any": [
            "text"
          ],
          "none": [
            "text"
          ]
        },
        "chat_types": [
          "channel"
        ],
        "mention_only": true,
        "exclude_self": true,
        "exclude_sent_by": [
          "campaign"
        ],
        "exclude_connection_ids": [
          "text"
        ],
        "exclude_own_connection": true,
        "include_backfill": true,
        "conversation_ids": [
          "text"
        ],
        "conversation_tags": [
          "text"
        ],
        "has_media": true,
        "person_stage_ids": [
          "text"
        ],
        "campaign_ids": [
          "text"
        ]
      },
      "filters_text": "text",
      "content_mode": "full",
      "content_type": "application/json",
      "revision": 1,
      "verified_at": "2026-10-22T12:00:00.000Z",
      "tested_at": "2026-10-22T12:00:00.000Z",
      "ready": true,
      "consecutive_failures": 1,
      "failing_since": "text",
      "last_success_at": "2026-10-22T12:00:00.000Z",
      "last_failure_at": "2026-10-22T12:00:00.000Z",
      "created_at": "2026-10-22T12:00:00.000Z",
      "updated_at": "2026-10-22T12:00:00.000Z",
      "url": "text",
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "text",
      "description": "text",
      "url_masked": "text"
    }
  }
}
```

## Using it over MCP

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