Creates a webhook

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Create a new webhook.

POST /api/v2/webhooks

Creates a webhook

cURL

curl --request POST \
  --url https://app.launchdarkly.com/api/v2/webhooks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "apidocs test webhook",
  "on": true,
  "sign": false,
  "statements": [
    {
      "actions": [
        "*"
      ],
      "effect": "allow",
      "resources": [
        "proj/test"
      ]
    }
  ],
  "tags": [
    "example-tag"
  ],
  "url": "https://example.com"
}
'

200

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

Authorizations

Authorization · string · header · required

Body

application/json

url · string · required

The URL of the remote webhook

Example:

"http://www.example.com"

sign · boolean · required

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

Example:

true

on · boolean · required

Whether or not this webhook is enabled.

Example:

true

name · string

A human-readable name for your webhook

Example:

"Example hook"

secret · string

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

Example:

"frobozz"

statements · object[]

Represents a Custom role policy, defining a resource kinds filter the webhook should respond to.

Show child attributes

tags · string[]

List of tags for this webhook

Example:

[]

Response

200

application/json

Webhook response

_links · object · required

The location and content type of related resources

Show child attributes

_id · string · required

The ID of this webhook

Example:

"57be1db38b75bf0772d11384"

url · string · required

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

Example:

"http://www.example.com"

on · boolean · required

Whether or not this webhook is enabled

Example:

true

tags · string[] · required

List of tags for this webhook

Example:

["examples"]

name · string

A human-readable name for this webhook

Example:

"Example hook"

secret · string

The secret for this webhook

Example:

"frobozz"

statements · object[]

Represents a Custom role policy, defining a resource kinds filter the webhook responds to.

Show child attributes

_access · object

Details on the allowed and denied actions for this webhook

Show child attributes