Get Webhook - OpenTrain AI

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

opentrain webhooks get <WEBHOOK_ID> --json

{
  "webhookId": "<WEBHOOK_ID>"
}

{
  "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
  }
}

{
  "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"
  }
}

GET

api

public

webhooks

{webhookId}

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

opentrain webhooks get <WEBHOOK_ID> --json

{
  "webhookId": "<WEBHOOK_ID>"
}

{
  "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
  }
}

{
  "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"
  }
}

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

webhookId

string

required

The webhook subscription ID.

Response

webhook

object

Hide webhook

string

Webhook subscription ID.

url

string

The destination URL receiving deliveries.

eventTypes

string[]

Subscribed event types from the event catalog.

status

string

ACTIVE or DISABLED.

createdAt

string

ISO creation timestamp.

disabledAt

string | null

When the subscription was disabled; null while ACTIVE.

disabledReason

string | 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}`)

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

opentrain webhooks get <WEBHOOK_ID> --json

{
  "webhookId": "<WEBHOOK_ID>"
}

{
  "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
  }
}

{
  "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"
  }
}

Create Webhook

Delete Webhook

⌘I

​Request

​Response

​Errors

Request

Response

Errors