Get Webhook Endpoint

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

endpointIdstringpathrequired

The webhook endpoint ID, from create or list.

Response

webhookEndpointobject

WebhookEndpoint fields

idstring

Endpoint ID.

urlstring

The delivery URL.

eventTypesstring[]

Subscribed event types.

statusstring

ACTIVE or DISABLED. Deliveries are only attempted while ACTIVE.

createdAtstring

ISO 8601 creation timestamp.

consecutiveFailuresinteger

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

disabledAtstring | null

When the endpoint was disabled, or null.

disabledReasonstring | 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

Request examples

curl

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

Response examples

200

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