Update webhook — LaunchDarkly

Update a webhook’s settings. Updating webhook settings uses a JSON patch representation of the desired changes. To learn more, read Updates.

Path parameters

idstringRequired

The ID of the webhook to update

Request

This endpoint expects a list of objects.

list of objects

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

namestringOptional

A human-readable name for this webhook

secretstringOptional

The secret for this webhook

statementslist of objectsOptional

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

_accessobjectOptional

Details on the allowed and denied actions for this webhook

Errors

1 curl -X PATCH https://app.launchdarkly.com/api/v2/webhooks/id \ 2 -H "Authorization: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '[ 5 { 6 "op": "replace", 7 "path": "/on", 8 "value": false 9 } 10 ]'

1 { 2 "_links": { 3 "key": { 4 "href": "href", 5 "type": "type" 6 } 7 }, 8 "_id": "57be1db38b75bf0772d11384", 9 "url": "http://www.example.com", 10 "on": true, 11 "tags": [ 12 "examples" 13 ], 14 "name": "Example hook", 15 "secret": "frobozz", 16 "statements": [ 17 { 18 "effect": "allow", 19 "resources": [ 20 "proj/*:env/*;qa_*:/flag/*" 21 ], 22 "notResources": [ 23 "notResources" 24 ], 25 "actions": [ 26 "*" 27 ], 28 "notActions": [ 29 "notActions" 30 ] 31 } 32 ], 33 "_access": { 34 "denied": [ 35 { 36 "action": "action", 37 "reason": { 38 "effect": "allow" 39 } 40 } 41 ], 42 "allowed": [ 43 { 44 "action": "action", 45 "reason": { 46 "effect": "allow" 47 } 48 } 49 ] 50 } 51 }

1	curl -X PATCH https://app.launchdarkly.com/api/v2/webhooks/id \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '[
5	{
6	"op": "replace",
7	"path": "/on",
8	"value": false
9	}
10	]'

1	{
2	"_links": {
3	"key": {
4	"href": "href",
5	"type": "type"
6	}
7	},
8	"_id": "57be1db38b75bf0772d11384",
9	"url": "http://www.example.com",
10	"on": true,
11	"tags": [
12	"examples"
13	],
14	"name": "Example hook",
15	"secret": "frobozz",
16	"statements": [
17	{
18	"effect": "allow",
19	"resources": [
20	"proj/:env/;qa_:/flag/"
21	],
22	"notResources": [
23	"notResources"
24	],
25	"actions": [
26	"*"
27	],
28	"notActions": [
29	"notActions"
30	]
31	}
32	],
33	"_access": {
34	"denied": [
35	{
36	"action": "action",
37	"reason": {
38	"effect": "allow"
39	}
40	}
41	],
42	"allowed": [
43	{
44	"action": "action",
45	"reason": {
46	"effect": "allow"
47	}
48	}
49	]
50	}
51	}