v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Webhooks

Update webhook

Update a webhook's settings. Updating webhook settings uses a JSON patch representation of the desired changes. To learn more, read Updates.

patch/api/v2/webhooks/{id}

Path parameters

idstring string required

The ID of the webhook to update

Request body

opstring required

The type of operation to perform

pathstring required

A JSON Pointer string specifying the part of the document to operate on

valuestring

A JSON value used in "add", "replace", and "test" operations

Example request

[
  {
    "op": "replace",
    "path": "/exampleField",
    "value": "new example value"
  }
]

Response

Webhook response

_linksobject required

The location and content type of related resources

_idstring required

The ID of this webhook

namestring

A human-readable name for this webhook

urlstring required

The URL to which LaunchDarkly sends an HTTP POST payload for this webhook

secretstring

The secret for this webhook

onboolean required

Whether or not this webhook is enabled

tagsstring[] required

List of tags for this webhook

Example response

{
  "_id": "57be1db38b75bf0772d11384",
  "name": "Example hook",
  "url": "http://www.example.com",
  "secret": "frobozz",
  "statements": [
    {
      "resources": [
        "proj/*:env/*;qa_*:/flag/*"
      ],
      "actions": [
        "*"
      ],
      "effect": "allow"
    }
  ],
  "on": true,
  "tags": [
    "examples"
  ],
  "_access": {
    "denied": [
      {
        "reason": {
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ],
          "effect": "allow"
        }
      }
    ],
    "allowed": [
      {
        "reason": {
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ],
          "effect": "allow"
        }
      }
    ]
  }
}