Create flag trigger — LaunchDarkly

Create a new flag trigger.

Path parameters

projectKeystringRequired

The project key

environmentKeystringRequired

The environment key

featureFlagKeystringRequired

The feature flag key

Request

This endpoint expects an object.

integrationKeystringRequired

The unique identifier of the integration for your trigger. Use generic-trigger for integrations not explicitly supported.

commentstringOptional

Optional comment describing the trigger

instructionslist of maps from strings to anyOptional

The action to perform when triggering. This should be an array with a single object that looks like <code>{“kind”: “flag_action”}</code>. Supported flag actions are <code>turnFlagOn</code> and <code>turnFlagOff</code>.

Response

Flag trigger response

_idstringOptional

The ID of this flag trigger

_versionintegerOptional

The flag trigger version

_creationDatelongOptional

Timestamp of when the flag trigger was created

_maintainerIdstringOptional

The ID of the flag trigger maintainer

_maintainerobjectOptional

Details on the member who maintains this flag trigger

enabledbooleanOptional

Whether the flag trigger is currently enabled

_integrationKeystringOptional

The unique identifier of the integration for your trigger

instructionslist of maps from strings to anyOptional

Details on the action to perform when triggering

_lastTriggeredAtlongOptional

Timestamp of when the trigger was most recently executed

_recentTriggerBodieslist of objectsOptional

Details on recent flag trigger requests.

_triggerCountintegerOptional

Number of times the trigger has been executed

triggerURLstringOptional

The unguessable URL for this flag trigger

_linksmap from strings to objectsOptional

The location and content type of related resources

Errors

1 curl -X POST https://app.launchdarkly.com/api/v2/flags/projectKey/featureFlagKey/triggers/environmentKey \ 2 -H "Authorization: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "integrationKey": "generic-trigger" 6 }'

1 { 2 "_id": "_id", 3 "_version": 1, 4 "_creationDate": 1000000, 5 "_maintainerId": "12ab3c45de678910abc12345", 6 "_maintainer": { 7 "_links": { 8 "self": { 9 "href": "/api/v2/members/569f183514f4432160000007", 10 "type": "application/json" 11 } 12 }, 13 "_id": "569f183514f4432160000007", 14 "role": "admin", 15 "email": "ariel@acme.com", 16 "firstName": "Ariel", 17 "lastName": "Flores" 18 }, 19 "enabled": true, 20 "_integrationKey": "generic-trigger", 21 "instructions": [ 22 { 23 "key": "value" 24 } 25 ], 26 "_lastTriggeredAt": 1000000, 27 "_recentTriggerBodies": [ 28 { 29 "timestamp": 1000000, 30 "jsonBody": { 31 "key": "value" 32 } 33 } 34 ], 35 "_triggerCount": 3, 36 "triggerURL": "triggerURL", 37 "_links": { 38 "key": { 39 "href": "href", 40 "type": "type" 41 } 42 } 43 }

1	curl -X POST https://app.launchdarkly.com/api/v2/flags/projectKey/featureFlagKey/triggers/environmentKey \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"integrationKey": "generic-trigger"
6	}'

1	{
2	"_id": "_id",
3	"_version": 1,
4	"_creationDate": 1000000,
5	"_maintainerId": "12ab3c45de678910abc12345",
6	"_maintainer": {
7	"_links": {
8	"self": {
9	"href": "/api/v2/members/569f183514f4432160000007",
10	"type": "application/json"
11	}
12	},
13	"_id": "569f183514f4432160000007",
14	"role": "admin",
15	"email": "ariel@acme.com",
16	"firstName": "Ariel",
17	"lastName": "Flores"
18	},
19	"enabled": true,
20	"_integrationKey": "generic-trigger",
21	"instructions": [
22	{
23	"key": "value"
24	}
25	],
26	"_lastTriggeredAt": 1000000,
27	"_recentTriggerBodies": [
28	{
29	"timestamp": 1000000,
30	"jsonBody": {
31	"key": "value"
32	}
33	}
34	],
35	"_triggerCount": 3,
36	"triggerURL": "triggerURL",
37	"_links": {
38	"key": {
39	"href": "href",
40	"type": "type"
41	}
42	}
43	}