Get Webhook

Reads one webhook subscription. The most common use is health-checking: if your endpoint has stopped receiving events, read the subscription and check status — a DISABLED webhook receives no deliveries, and disabledReason explains why (typically repeated delivery failures; see the delivery lifecycle).

The signing secret is never returned — it is shown only once at creation. If it is lost, delete the subscription and create a new one. Webhooks belonging to another account return 404.

Requirements: webhooks:manage scope + the public_api_webhooks feature.

Request

webhookIdstringpathrequired

The webhook subscription ID.

Response

webhookobject

webhook

idstring

Webhook subscription ID.

urlstring

The destination URL receiving deliveries.

eventTypesstring[]

Subscribed event types from the event catalog.

statusstring

ACTIVE or DISABLED.

createdAtstring

ISO creation timestamp.

disabledAtstring | null

When the subscription was disabled; null while ACTIVE.

disabledReasonstring | null

Why it was disabled. Recover by deleting and re-creating the subscription, then catch up on missed events with GET /updates.

Errors

Status	code	Meaning
401	UNAUTHORIZED	Missing or invalid token
403	FORBIDDEN	Missing webhooks:manage scope, or public_api_webhooks disabled
404	NOT_FOUND	No such webhook, or it belongs to another account (details: {resource: "webhooks", webhookId})

Request examples

curlCLIMCP: opentrain_get_webhook

curl

curl -sS https://app.opentrain.ai/api/public/v1/webhooks/<WEBHOOK_ID> \
  -H "Authorization: Bearer $OT_API_TOKEN"

CLI

opentrain webhooks get <WEBHOOK_ID> --json

MCP: opentrain_get_webhook

{
  "webhookId": "<WEBHOOK_ID>"
}

Response examples

200 (active)200 (auto-disabled)

200 (active)

{
  "webhook": {
    "id": "<WEBHOOK_ID>",
    "url": "https://example.com/hooks/opentrain",
    "eventTypes": ["proposal.received", "message.received", "approval.confirmed"],
    "status": "ACTIVE",
    "createdAt": "2026-06-12T10:00:00.000Z",
    "disabledAt": null,
    "disabledReason": null
  }
}

200 (auto-disabled)

{
  "webhook": {
    "id": "<WEBHOOK_ID>",
    "url": "https://example.com/hooks/opentrain",
    "eventTypes": ["proposal.received"],
    "status": "DISABLED",
    "createdAt": "2026-05-30T08:00:00.000Z",
    "disabledAt": "2026-06-10T14:20:00.000Z",
    "disabledReason": "Disabled after repeated delivery failures"
  }
}