List Webhook Endpoints - OpenTrain AI

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

{
  "webhookEndpoints": [
    {
      "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

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

{
  "webhookEndpoints": [
    {
      "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
    }
  ]
}

Lists every webhook endpoint registered on the calling token’s install, newest first. Use it to monitor delivery health — a non-zero consecutiveFailures or a DISABLED status means your receiver needs attention. Requirements: webhooks:manage scope.

Request

No parameters.

Response

webhookEndpoints

object[]

Array of webhook endpoints, newest first. The signing secret is never included — it is only returned once, by create.

Show WebhookEndpoint fields

string

Endpoint ID.

url

string

The delivery URL.

eventTypes

string[]

Subscribed event types.

status

string

ACTIVE or DISABLED. Deliveries are only attempted while ACTIVE.

createdAt

string

ISO 8601 creation timestamp.

consecutiveFailures

integer

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

disabledAt

string | null

When the endpoint was disabled, or null.

disabledReason

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`

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

{
  "webhookEndpoints": [
    {
      "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
    }
  ]
}

Report Usage

Create Webhook Endpoint

⌘I

​Request

​Response

​Errors

Request

Response

Errors