For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inTry it free
DocsGuidesSDKsIntegrationsAPI docsTutorialsFlagship blog
DocsGuidesSDKsIntegrationsAPI docsTutorialsFlagship blog
  • REST API overview
    • Access Tokens
    • Account Members
    • Account Usage Beta
    • AI Configs
    • Announcements
    • Applications Beta
    • Approvals
    • Approvals Beta
    • Audit Log
    • Code References
    • Contexts
    • Context Settings
    • Custom Roles
    • Data Export Destinations
    • Environments
    • Experiments
    • Feature Flags
    • Feature Flags Beta
    • Flag Import Configurations Beta
    • Flag Links Beta
    • Flag Triggers
    • Follow Flags
    • Holdouts Beta
    • Insights Charts Beta
    • Insights Deployments Beta
    • Insights Flag Events Beta
    • Insights Pull Requests Beta
    • Insights Repositories Beta
    • Insights Scores Beta
    • Integration Audit Log Subscriptions
    • Integration Delivery Configurations Beta
    • Integrations Beta
    • Layers
    • Metrics
    • Metrics Beta
    • OAuth2 Clients
    • Persistent Store Integrations Beta
    • Projects
    • Relay Proxy Configurations
    • Release Pipelines Beta
    • Releases Beta
    • Scheduled Changes
    • Segments
    • Tags
    • Teams
    • Teams Beta
    • Users
    • Users Beta
    • User Settings
    • Views Beta
    • Webhooks
      • POSTCreates a webhook
      • DELDelete webhook
      • GETGet webhook
      • GETList webhooks
      • PATCHUpdate webhook
    • Workflows
    • Workflow Templates
    • Other
Sign inTry it free
LogoLogo
REST API overviewWebhooks

Creates a webhook

POST
/api/v2/webhooks
POST
/api/v2/webhooks
$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"
>  ]
>}'
1{
2  "_links": {},
3  "_id": "57be1db38b75bf0772d11384",
4  "url": "http://www.example.com",
5  "on": true,
6  "tags": [
7    "examples"
8  ],
9  "name": "Example hook",
10  "secret": "frobozz",
11  "statements": [
12    {
13      "effect": "allow",
14      "resources": [
15        "proj/*:env/*;qa_*:/flag/*"
16      ],
17      "notResources": [
18        "string"
19      ],
20      "actions": [
21        "*"
22      ],
23      "notActions": [
24        "string"
25      ]
26    }
27  ],
28  "_access": {
29    "denied": [
30      {
31        "action": "string",
32        "reason": {
33          "effect": "allow",
34          "resources": [
35            "proj/*:env/*;qa_*:/flag/*"
36          ],
37          "notResources": [
38            "string"
39          ],
40          "actions": [
41            "*"
42          ],
43          "notActions": [
44            "string"
45          ],
46          "role_name": "string"
47        }
48      }
49    ],
50    "allowed": [
51      {
52        "action": "string",
53        "reason": {
54          "effect": "allow",
55          "resources": [
56            "proj/*:env/*;qa_*:/flag/*"
57          ],
58          "notResources": [
59            "string"
60          ],
61          "actions": [
62            "*"
63          ],
64          "notActions": [
65            "string"
66          ],
67          "role_name": "string"
68        }
69      }
70    ]
71  }
72}
Create a new webhook.
Was this page helpful?
Previous

Delete webhook

Next
Built with

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