Update webhook endpoint

Patches a webhook endpoint. URL, secret, eventTypes, isActive and metadata are each independently patchable. URL changes re-run the HTTPS + SSRF check; secret changes re-encrypt at rest; eventTypes changes re-validate against the canonical control-plane catalog. nil fields mean “leave unchanged”; an explicit empty eventTypes slice means “clear the subscription list”.

PATCH /v1/str/webhooks/{webhookId}

Update webhook endpoint

cURL

curl --request PATCH \
  --url https://spb.sandbox.lerian.net/v1/str/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventTypes": [
    "<string>"
  ],
  "isActive": true,
  "metadata": {},
  "secret": "<string>",
  "url": "<string>"
}
'

200

{
  "correlationId": "<string>",
  "webhook": {
    "createdAt": "<string>",
    "eventTypes": [
      "<string>"
    ],
    "isActive": true,
    "messageTypes": [
      "<string>"
    ],
    "updatedAt": "<string>",
    "url": "<string>",
    "webhookId": "<string>",
    "metadata": {}
  }
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency · string

Idempotency key (canonical).

X-Idempotency-Key · string

Idempotency key (legacy alias).

X-TTL · string

Idempotency key TTL in seconds.

Example:

"86400"

Path Parameters

webhookId · string · required

Webhook UUID.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

eventTypes · string[]

New subscription list, re-validated against the canonical catalog. Omit to leave unchanged; an explicit empty array clears the subscription.

isActive · boolean

New active flag for the endpoint. Omit to leave unchanged.

metadata · object

New client-defined metadata. Omit to leave unchanged.

Show child attributes

secret · string

New shared signing secret (16-512 chars); re-encrypted at rest. Omit to leave unchanged.

Example:

"whsec_0123456789abcdef"

url · string

New HTTPS endpoint; re-runs the HTTPS + SSRF check. Omit to leave unchanged.

Example:

"https://example.com/webhooks/str-events"

Response

200

application/json

OK

correlationId · string · required

Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace.

Example:

"550e8400-e29b-41d4-a716-446655440001"

webhook · object · required

The created, fetched, or updated webhook endpoint.

Show child attributes