Creates a webhook | LaunchDarkly

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

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

Create a new webhook.

Authentication

Authorizationstring

API Key authentication via header

Request

This endpoint expects an object.

urlstringRequired

The URL of the remote webhook

signbooleanRequired

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

onbooleanRequired

Whether or not this webhook is enabled.

namestringOptional

A human-readable name for your webhook

secretstringOptional

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

statementslist of objectsOptional

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

tagslist of stringsOptional

List of tags for this webhook

Response

Webhook response

_linksmap from strings to objects

The location and content type of related resources

_idstring

The ID of this webhook

urlstring

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

onboolean

Whether or not this webhook is enabled

tagslist of strings

List of tags for this webhook

namestring

A human-readable name for this webhook

secretstring

The secret for this webhook

statementslist of objects

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

_accessobject

Details on the allowed and denied actions for this webhook

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error