Skip to main content
GET
/
api
/
partner
/
v1
/
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.

​
Errors

StatuscodeMeaning
401UNAUTHORIZEDMissing, invalid, or revoked token
403FORBIDDENToken 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
    }
  ]
}