Translation APIReference
v2.0.0

Webhooks

Update URL, events, description, or status

Update the HTTPS destination, event subscriptions, display name, or active state.

PATCH/webhooks/{webhookId}

API key permission: webhooks:write. Send a unique Idempotency-Key and reuse it only when retrying the same request.

Parameters

NameTypeDescription
webhookIdstring · required

path parameter

Idempotency-Keystring · required

Unique operation key. Reuse it only with the same method, path, and request body.

Request body

application/json
namestringOptional

See schema for validation constraints.

urlstringOptional

See schema for validation constraints.

eventsWebhookEventType[]Optional

See schema for validation constraints.

statusstringOptional

See schema for validation constraints.

Standard response headers

HeaderExampleDescription
Stepes-Request-Idb09de4aa-3874-4991-b85c-0bc86e780511

Server-generated request identifier for support and audit correlation.

Stepes-API-Version2.0.0

Effective Stepes API semantic version.

RateLimit-Policy120;w=60

Effective request limit and window for the authenticated key.

RateLimitlimit=120, remaining=119, reset=60

Current limit, remaining requests, and reset interval.

Idempotency-Replayedtrue

Present with value true when a stored mutation response is replayed.

Responses

200

Updated webhook

404

Resource was not found or is not available to this API key

409

Idempotency conflict or invalid lifecycle transition

422

Request validation failed

{
  "id": "string",
  "object": "webhook_endpoint",
  "url": "https://example.com/resource",
  "name": "string",
  "events": [
    "quote.created"
  ],
  "status": "active",
  "created_at": "2026-07-23T12:00:00Z",
  "updated_at": "2026-07-23T12:00:00Z"
}