def update(id, patch = nil, timeout: nil, **fields)

def update: (
  String id,
  ?(webhook_patch | Hash[Symbol | String, untyped])? patch,
  ?timeout: seconds?,
  **untyped
) -> webhook_resource

Patches the name, URL, description, subscription set or enabled flag. At least one of those keys must be present: an empty Hash is a 400, not a no-op. url is re-validated against the full https and public host ruleset on every change, and passing nil or an empty string for description clears the note.

eventTypes replaces the subscription set wholesale, unlike scopes on keys.update, which merges. Send the complete list you want rather than a delta. It must stay non empty, so there is no way to subscribe to nothing: disable the endpoint instead.

Disabling does not drain the queue. Deliveries already queued are not cancelled, the worker picks them up, sees the endpoint is disabled and marks them failed with Endpoint disabled, so expect a burst of failures in the log right after you turn it off. Nothing new is queued while enabled is false, and events that occur during the downtime are lost to this endpoint rather than buffered.

Example

ruby

require "envless/sdk"

endpoint_id = "0194f2b1-9c3a-7c21-8f0e-2b6d4a1c5e90"
updated = Envless.webhooks.update(
  endpoint_id,
  eventTypes: [
    "variable.created",
    "variable.updated",
    "variable_version.created"
  ],
  enabled: true
)

puts updated[:eventTypes]

Parameters

Parameter	Type	Required	Description
`id`	`String`	Yes	Endpoint id, ids only and no slug form.
`patch`	`webhook_patch`	No	The fields below as one Hash, with Symbol or String keys, in place of the keywords.
`url:`	`String`	No	Replacement https URL, re-validated against the full host ruleset.
`eventTypes:`	`Array[String]`	No	Complete replacement subscription set, which must stay non empty.
`name:`	`String`	No	Replacement label, at most 64 characters and never blank: an empty string is a 400, not a way to clear it.
`description:`	`String \| nil`	No	Replacement note, at most 200 characters, or empty to clear it.
`enabled:`	`bool`	No	Set false to stop queuing new deliveries, must be a boolean.
`timeout:`	`Integer \| Float \| Rational`	No	Seconds each attempt of this call may take, redirects and the response body included, before it raises `Envless::NetworkError` with `timeout?` set. Overrides the client's `timeout` for this call, and `0` turns the limit off.

Returns

webhook_resource reflecting the saved endpoint, still with secretLastFour in place of any secret.

Worth knowing

The signing secret is untouched by this route, use rotate_secret to change it.
Read the current eventTypes first if you mean to add one, since a partial list silently unsubscribes the rest.

Required scopes

webhooks:write

Underlying endpoint

PATCH /webhooks/{id}

Request and response schema, every error code, and a live playground.

In TypeScript

envless.webhooks.update()

The same method in @goenvless/sdk, with the same request, retries and errors.

Example#

Parameters#

Returns#

Worth knowing#

Required scopes#

Underlying endpoint#