> ## Documentation Index
> Fetch the complete documentation index at: https://opentrain.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Webhook Endpoint

> Retrieve one webhook endpoint and its delivery health: status, consecutive failures, and disable reason.

Retrieves one [webhook endpoint](/docs/developers/annotation-platforms/webhooks) on the calling token's install, including its delivery-health fields. The signing secret is never returned — it is only shown once, by [create](/docs/developers/annotation-platforms/api-reference/webhook-endpoints/create).

**Requirements:** `webhooks:manage` scope.

## Request

<ParamField path="endpointId" type="string" required>
  The webhook endpoint ID, from [create](/docs/developers/annotation-platforms/api-reference/webhook-endpoints/create) or [list](/docs/developers/annotation-platforms/api-reference/webhook-endpoints/list).
</ParamField>

## Response

<ResponseField name="webhookEndpoint" type="object">
  <Expandable title="WebhookEndpoint fields">
    <ResponseField name="id" type="string">
      Endpoint ID.
    </ResponseField>

    <ResponseField name="url" type="string">
      The delivery URL.
    </ResponseField>

    <ResponseField name="eventTypes" type="string[]">
      Subscribed [event types](/docs/developers/annotation-platforms/lifecycle-events).
    </ResponseField>

    <ResponseField name="status" type="string">
      `ACTIVE` or `DISABLED`. Deliveries are only attempted while `ACTIVE`.
    </ResponseField>

    <ResponseField name="createdAt" type="string">
      ISO 8601 creation timestamp.
    </ResponseField>

    <ResponseField name="consecutiveFailures" type="integer">
      Failed deliveries in a row. Resets to `0` on any successful delivery; at 10 the endpoint is auto-disabled.
    </ResponseField>

    <ResponseField name="disabledAt" type="string | null">
      When the endpoint was disabled, or `null`.
    </ResponseField>

    <ResponseField name="disabledReason" type="string | null">
      Why the endpoint was disabled, or `null`.
    </ResponseField>
  </Expandable>
</ResponseField>

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

<RequestExample>
  ```bash curl theme={null}
  curl -sS https://app.opentrain.ai/api/partner/v1/webhook-endpoints/<ENDPOINT_ID> \
    -H "Authorization: Bearer $OT_PARTNER_TOKEN"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "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
    }
  }
  ```
</ResponseExample>