Update a webhook endpoint

patch

https://api.lingohub.com/v2/webhook-endpoints/{webhookEndpointId}

Updates delivery URL, description, event subscriptions and optional stack/project scope using JSON merge-patch. Omitted fields are preserved; null clears description or scope, and event_types replaces the list. Switching from a stack to a project requires clearing stack_id in the same request, and conversely. Empty patches write nothing. Status, health, payload version and signing material are unchanged. Optional If-Match uses the ordinary endpoint GET validator. Requires workspace-level API access management permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

webhookEndpointId

string

required

^whe_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Public id composed of the resource type prefix and its UUID.

Body Params

Request body to partially update a webhook endpoint. Omitted fields stay unchanged; null clears description or scope. Switching scope requires explicitly clearing the previous scope. Event types replace the complete subscription list.

url

string

length between 1 and 2048

Public HTTPS delivery URL.

description

string | null

Endpoint description; null clears it.

event_types

array of strings

length ≥ 1

Replacement public event names, or ["*"] for all subscribable events.

event_types

stack_id

string | null

^stack_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Stack scope in this workspace; null clears it.

project_id

string | null

^pr_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Project scope in this workspace; null clears it.

Headers

If-Match

string

Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Updated webhook endpoint without signing material.

400The request is malformed: an unknown or invalid query parameter, an invalid id in the path, or a body that is not valid JSON. code names the problem, errors the parameter or field.

401Invalid or missing API key.

403Insufficient permissions.

404The resource does not exist, or the API key cannot see it.

412The current representation does not match If-Match (precondition_failed). No change was applied.

422The request is well-formed, but values are invalid; errors points at each of them.

429The API rate limit was exceeded. Wait for the number of seconds given in the Retry-After header, then retry.

500An unexpected internal server error occurred.

503The service is temporarily unavailable. Retry after the number of seconds in the Retry-After header.