Sign in

v5

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

Creates a webhook

Create a new webhook.

post/api/v2/webhooks

Request body

namestring

A human-readable name for your webhook

urlstring required

The URL of the remote webhook

secretstring

If sign is true, and the secret attribute is omitted, LaunchDarkly automatically generates a secret for you.

signboolean required

If sign is false, the webhook does not include a signature header, and the secret can be omitted.

onboolean required

Whether or not this webhook is enabled.

tagsstring[]

List of tags for this webhook

Example request

{
  "name": "Example hook",
  "url": "http://www.example.com",
  "secret": "frobozz",
  "statements": [
    {
      "resources": [
        "proj/*:env/*:flag/*;testing-tag"
      ],
      "actions": [
        "*"
      ],
      "effect": "allow"
    }
  ],
  "sign": true,
  "on": true,
  "tags": []
}

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"
        }
      }
    ]
  }
}