Get Webhook Endpoint

curl -sS https://app.opentrain.ai/api/partner/v1/webhook-endpoints/<ENDPOINT_ID> \
  -H "Authorization: Bearer $OT_PARTNER_TOKEN"

{
  "webhookEndpoint": {
    "id": "<ENDPOINT_ID>",
    "url": "https://your-platform.example.com/webhooks/opentrain",
    "eventTypes": ["contract.started", "contract.ended"],
    "status": "ACTIVE",
    "createdAt": "2026-06-12T10:00:00.000Z",
    "consecutiveFailures": 0,
    "disabledAt": null,
    "disabledReason": null
  }
}

GET

api

partner

webhook-endpoints

{endpointId}

curl -sS https://app.opentrain.ai/api/partner/v1/webhook-endpoints/<ENDPOINT_ID> \
  -H "Authorization: Bearer $OT_PARTNER_TOKEN"

{
  "webhookEndpoint": {
    "id": "<ENDPOINT_ID>",
    "url": "https://your-platform.example.com/webhooks/opentrain",
    "eventTypes": ["contract.started", "contract.ended"],
    "status": "ACTIVE",
    "createdAt": "2026-06-12T10:00:00.000Z",
    "consecutiveFailures": 0,
    "disabledAt": null,
    "disabledReason": null
  }
}

Retrieves one webhook endpoint on the calling token’s install, including its delivery-health fields. The signing secret is never returned — it is only shown once, by create. Requirements: webhooks:manage scope.

Request

string

required

The webhook endpoint ID, from create or list.

Response

object

Show WebhookEndpoint fields

string

Endpoint ID.

string

The delivery URL.

string[]

Subscribed event types.

string

ACTIVE or DISABLED. Deliveries are only attempted while ACTIVE.

string

ISO 8601 creation timestamp.

integer

Failed deliveries in a row. Resets to 0 on any successful delivery; at 10 the endpoint is auto-disabled.

string | null

When the endpoint was disabled, or null.

string | null

Why the endpoint was disabled, or null.

Errors

Status	`code`	Meaning
`401`	`UNAUTHORIZED`	Missing, invalid, or revoked token
`403`	`FORBIDDEN`	Token lacks `webhooks:manage`
`404`	`NOT_FOUND`	No endpoint with this ID on this install

curl -sS https://app.opentrain.ai/api/partner/v1/webhook-endpoints/<ENDPOINT_ID> \
  -H "Authorization: Bearer $OT_PARTNER_TOKEN"

{
  "webhookEndpoint": {
    "id": "<ENDPOINT_ID>",
    "url": "https://your-platform.example.com/webhooks/opentrain",
    "eventTypes": ["contract.started", "contract.ended"],
    "status": "ACTIVE",
    "createdAt": "2026-06-12T10:00:00.000Z",
    "consecutiveFailures": 0,
    "disabledAt": null,
    "disabledReason": null
  }
}

Create Webhook Endpoint

Update Webhook Endpoint

⌘I

Getting started

Connect your agent

Core concepts

Guides

API reference

CLI

MCP server

Annotation platforms

Request

Response

Errors

​Request

​Response

​Errors

Request

Response

Errors