Webhooks

Update a webhook endpoint

Changes any of url, events and description (null clears it), and turns deliveries off and on with disabled. {"disabled": false} turns back on an endpoint Leap disabled after 72 hours of failures, and clears disabled_reason. Fields you leave out stay as they are.

Needs an API key with the generations:write scope.

patch/v1/webhook_endpoints/{id}

Request

  • Base URL: https://api.tryleap.ai
  • URL: https://api.tryleap.ai/v1/webhook_endpoints/{id}
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

idstring required

The endpoint's ID, we_....

Request body

urlstring uri

A new https URL for the endpoint.

eventsstring[]

The event types to send, replacing the current list. ["*"] sends every type.

descriptionstring nullable

A new note; null clears it.

disabledboolean

true stops deliveries to the endpoint; false starts them again and clears disabled_reason.

Response

The endpoint.

idstring required

The endpoint's ID, we_....

object'webhook_endpoint' required
urlstring required

Where Leap POSTs events.

descriptionstring nullable required

Your note, if any.

eventsstring[] required

The event types it gets; ["*"] for every type, including types added later.

disabledboolean required

Whether deliveries to it are stopped.

disabled_reasonstring nullable required

Why Leap disabled the endpoint, such as every delivery failing for 72 hours; null when it is on or you turned it off.

created_atstring date-time required

When it was created.

updated_atstring date-time required

When it last changed.

Changes

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