---
title: "Api Webhooks Retrieve"
method: GET
path: "/api/webhooks/{id}/"
tags: ["webhooks"]
---

# Api Webhooks Retrieve

`GET /api/webhooks/{id}/`

GET /api/webhooks/<id>/ - Retrieve webhook details
PATCH /api/webhooks/<id>/ - Update webhook
DELETE /api/webhooks/<id>/ - Delete webhook

Query Parameters (GET):
    - is_including_secrets (boolean, optional): Set to 'true' to reveal secrets (default: false)

Request Body (PATCH):
    - url (string, optional): Update webhook URL
    - name (string, optional): Update webhook name
    - active (boolean, optional): Update active status
    - event_type (string, optional): Update event type

Response:
    - Webhook object (secrets included only if is_including_secrets=true)

## Path parameters

- `id` integer, required

## Query parameters

- `is_including_secrets` boolean

## Headers

- `Authorization` string, required

## Response `200`

- WebhookDetail — For detail operations - conditionally includes secret
  - `id` integer, required
  - `secrets` string, required
  - `project` string, nullable
  - `url` string, uri, required
  - `name` string
  - `created` string, date-time
  - `event_type` union
    - 'request_log' | 'on_eval_result_ingested' | 'trace_completed' | 'customer_budget_limit_reached' | 'credit_low_balance_threshold_reached' | 'spend_cap_warning_threshold_reached' | 'limit_policy_soft_triggered' | 'limit_policy_hard_triggered' — * `request_log` - Request Log * `on_eval_result_ingested` - Evaluation Result * `trace_completed` - Trace Completed * `customer_budget_limit_reached` - Customer Budget Limit Reached * `credit_low_balance_threshold_reached` - Credit Low Balance Threshold Reached * `spend_cap_warning_threshold_reached` - Spend Cap Warning Threshold Reached * `limit_policy_soft_triggered` - Limit Policy Soft Triggered * `limit_policy_hard_triggered` - Limit Policy Hard Triggered
    - ''
  - `active` boolean
  - `organization` integer, required
  - `organization_key` string, nullable

---

[API](https://skmtc.net/keywordsai/apis/api-reference.md) · [All operations](https://skmtc.net/keywordsai/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/keywordsai/api-reference/versions/c26d550029f8/schema)