Skip to main content
POST
Creates a webhook

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.

tags
string[]

List of tags for this webhook

Example:

Response

Webhook response

The location and content type of related resources

_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:
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.

_access
object

Details on the allowed and denied actions for this webhook