observability

Change a webhook's URL, description or events, or turn it off and on.

post/v1/webhooks/{id}:update

Request

  • Base URL: https://api.withruntime.com
  • URL: https://api.withruntime.com/v1/webhooks/{id}:update
  • Auth: HTTP bearer

Path parameters

idstring required

Resource identifier (UUID).

Headers

Idempotency-Keystring

Replaying the same key with the same request within 24 hours returns the first result and never repeats the effect. A refusal is not kept: a request refused before it ran (no_capacity, busy, a limit) runs afresh when sent again with its key. The SDKs send one automatically; the server makes one when absent and returns it in the idempotency-key response header.

Request body

urlstring

An https URL on the public internet.

descriptionstring nullable

null or empty clears it.

eventsstring[]

Which events to send; ["*"], the default, sends every type, including ones added later.

enabledboolean

false stops sending and cancels what is waiting.

Response

Success

idstring required
urlstring required
descriptionstring nullable
eventsstring[] required
enabledboolean required
secretHintstring required
secretstring

The signing secret. Returned when the webhook is made (and to its own retry) and when its secret is rotated, and never again.

previousSecretExpiresAtstring nullable
createdAtstring
updatedAtstring
lastSuccessAtstring nullable
lastFailureAtstring nullable
failingSincestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.