Update Webhook Endpoint

Updates a webhook endpoint. All body fields are optional — send only what you want to change. Setting status to ACTIVE re-enables an auto-disabled endpoint and resets its failure counter.

Updating never changes the signing secret, and the secret is never returned. To rotate it, delete the endpoint and create a new one.

Requirements: webhooks:manage scope.

Request

endpointIdstringpathrequired

The webhook endpoint ID.

urlstringbody

New delivery URL. Must be HTTPS (http is allowed for localhost only).

eventTypesstring[]body

Replacement list of event types — at least one.

statusstringbody

ACTIVE or DISABLED. ACTIVE re-enables an auto-disabled endpoint and resets consecutiveFailures to 0; DISABLED pauses delivery.

Response

webhookEndpointobject

The updated endpoint: {id, url, eventTypes, status, createdAt, consecutiveFailures, disabledAt, disabledReason} — same shape as GET /webhook-endpoints/{endpointId}.

Errors

Status	code	Meaning
400	BAD_REQUEST	Body not valid JSON, invalid url, empty/unknown eventTypes, or invalid status
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 -X PATCH https://app.opentrain.ai/api/partner/v1/webhook-endpoints/<ENDPOINT_ID> \
  -H "Authorization: Bearer $OT_PARTNER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status": "ACTIVE"}'

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