/
manifest.schema.json
4274 lines (4274 loc) · 181 KB
/
manifest.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://launchdarkly.com/schemas/v1.0/manifest.schema.json#",
"title": "LaunchDarkly Integrations Manifest",
"description": "Describes the capabilities and intent of a LaunchDarkly integration",
"type": "object",
"propertyNames": {
"enum": [
"name",
"version",
"overview",
"description",
"details",
"author",
"supportEmail",
"links",
"categories",
"icons",
"formVariables",
"capabilities",
"legacy",
"otherCapabilities",
"requiresOAuth",
"hideOnIntegrationsPage",
"oauthIntegrationKey"
]
},
"properties": {
"name": {
"$id": "#/properties/name",
"title": "Integration name",
"description": "Your integration's name.",
"minLength": 3,
"maxLength": 100,
"type": "string"
},
"version": {
"$id": "#/properties/version",
"title": "Version",
"description": "A semantic version of the integration. See https://semver.org for more info.",
"examples": [
"0.0.1",
"1.0.0",
"1.0.1-beta"
],
"type": "string",
"minLength": 5,
"maxLength": 14,
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
},
"overview": {
"$id": "#/properties/overview",
"title": "Short description",
"description": "A short-one liner describing your integration",
"type": "string",
"minLength": 10,
"maxLength": 100,
"pattern": "^(.*)$"
},
"description": {
"$id": "#/properties/description",
"title": "Long description",
"description": "A longer description of your integration",
"type": "string",
"minLength": 50,
"maxLength": 2048,
"pattern": "^(.*)$"
},
"details": {
"#id": "#/properties/details",
"title": "Learn more details",
"description": "Details about your integration and next steps if the installation happens outside of LaunchDarkly",
"type": "string",
"minLength": 50,
"maxLength": 2048,
"pattern": "^(.*)$"
},
"author": {
"$id": "#/properties/author",
"title": "Author",
"description": "Name of the author or organization responsible for the integration",
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^(.*)$"
},
"supportEmail": {
"$id": "#/properties/links/support-email",
"title": "Support Email",
"description": "Email address for your integration's support",
"type": "string",
"format": "email"
},
"links": {
"$id": "#/properties/links",
"title": "Links",
"description": "A set of reference links supporting your integration",
"type": "object",
"propertyNames": {
"enum": [
"site",
"launchdarklyDocs",
"privacyPolicy",
"supportWebsite"
]
},
"properties": {
"site": {
"$id": "#/properties/links/site",
"title": "Website",
"description": "URL to your website",
"type": "string",
"maxLength": 2048,
"pattern": "^[Hh][Tt][Tt][Pp][Ss]?://"
},
"launchdarklyDocs": {
"$id": "#/properties/links/launchdarkly-docs",
"title": "LaunchDarkly Documentation",
"description": "URL to the LaunchDarkly documentation for this integration",
"type": "string",
"maxLength": 2048,
"pattern": "^[Hh][Tt][Tt][Pp][Ss]?://"
},
"privacyPolicy": {
"$id": "#/properties/links/privacy-policy",
"title": "Privacy Policy",
"description": "URL to your organization's privacy policy",
"type": "string",
"maxLength": 2048,
"pattern": "^[Hh][Tt][Tt][Pp][Ss]?://"
},
"supportWebsite": {
"$id": "#/properties/links/support-website",
"title": "Support Website",
"description": "URL to your integration's support website",
"type": "string",
"maxLength": 2048,
"pattern": "^[Hh][Tt][Tt][Pp][Ss]?://"
}
},
"required": [
"site",
"privacyPolicy"
]
},
"categories": {
"$id": "#/properties/categories",
"title": "Categories",
"description": "Categories that describe your integration",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"maxItems": 3,
"items": {
"type": "string",
"enum": [
"analytics",
"approval",
"authentication",
"automation",
"code-references",
"customer-support",
"data",
"developer-tools",
"infrastructure",
"issue-tracking",
"log-management",
"messaging",
"monitoring",
"synced-segments",
"notifications"
]
}
},
"icons": {
"$id": "#/properties/icons",
"title": "Icons",
"description": "Logos describing your integration in SVG format",
"type": "object",
"propertyNames": {
"enum": [
"square",
"horizontal"
]
},
"properties": {
"square": {
"$id": "#/properties/icons/square",
"title": "Square logo",
"description": "A square version of your integration's logo in SVG format",
"type": "string",
"pattern": "\\.svg$"
},
"horizontal": {
"$id": "#/properties/icons/horizontal",
"title": "Horizontal logo",
"description": "A horizontal version of your integration's logo in SVG format",
"type": "string",
"pattern": "\\.svg$"
}
},
"required": [
"square",
"horizontal"
]
},
"legacy": {
"$id": "#/properties/legacy",
"title": "Legacy",
"description": "Legacy integration",
"type": "object",
"propertyNames": {
"enum": [
"kind"
]
},
"properties": {
"kind": {
"$id": "#/properties/legacy/kind",
"title": "Kind",
"description": "Kind of legacy integration",
"type": "string",
"enum": [
"codeRefs",
"datadog",
"dataExport",
"slackWebhooks",
"webhooks"
]
}
},
"required": [
"kind"
]
},
"otherCapabilities": {
"$id": "#/properties/other-capabilities",
"title": "Other capabilities",
"description": "Capabilities not configured by manifests",
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"enum": [
"codeRefs",
"dataExport",
"external",
"ide",
"sso",
"webhooks"
]
}
},
"requiresOAuth": {
"$id": "#/properties/requires-oauth",
"title": "Requires OAuth",
"type": "boolean",
"description": "Whether the integration authenticates using OAuth",
"default": false
},
"hideOnIntegrationsPage": {
"$id": "#/properties/hide-on-integrations-page",
"title": "Hide On Integrations Page",
"type": "boolean",
"description": "Whether the your app should be excluded from the list of integration cards displayed on our integrations page in the web app",
"default": false
},
"formVariables": {
"$id": "#/properties/form-variables",
"title": "Form variables",
"description": "Form variables will be rendered on the integration configuration page. These are variables you need an admin to supply when they enable the integration. Examples of a form variable include `apiToken` or `url`.",
"type": "array",
"items": {
"$id": "#/definitions/form-variable",
"title": "Form variable",
"description": "A form variable describes an object property that the LaunchDarkly admin will be prompted for when they configure an integration.",
"type": "object",
"propertyNames": {
"enum": [
"key",
"name",
"type",
"description",
"placeholder",
"isSecret",
"isHidden",
"isOptional",
"defaultValue",
"allowedValues",
"dynamicOptions",
"dependsOn"
]
},
"properties": {
"key": {
"$id": "#/definitions/form-variable/key",
"title": "Key",
"type": "string",
"description": "A key will be used as the token name when the variable is substituted",
"maxLength": 20,
"pattern": "^[^\\s]*$"
},
"name": {
"$id": "#/definitions/form-variable/name",
"title": "Name",
"type": "string",
"description": "A descriptive name that will be used as the form label on the UI",
"maxLength": 50
},
"type": {
"$id": "#/definitions/form-variable/type",
"title": "Type",
"type": "string",
"description": "The type of the variable",
"enum": [
"string",
"boolean",
"uri",
"enum",
"oauth",
"dynamicEnum",
"generated"
]
},
"description": {
"$id": "#/definitions/form-variable/description",
"title": "Description",
"type": "string",
"description": "Describes the variable in the UI. Markdown links allowed.",
"maxLength": 250
},
"placeholder": {
"$id": "#/definitions/form-variable/placeholder",
"title": "Description",
"type": "string",
"description": "Placeholder value to use in the form element if applicable"
},
"isSecret": {
"$id": "#/definitions/form-variable/is-secret",
"title": "Is this variable a secret?",
"type": "boolean",
"description": "Secret variables will be masked in the UI",
"default": false
},
"isOptional": {
"$id": "#/definitions/form-variable/is-optional",
"title": "Is this variable optional?",
"type": "boolean",
"description": "Variables marked as optional won't be required on the UI",
"default": false
},
"isHidden": {
"$id": "#/definitions/form-variable/is-hidden",
"title": "Hide variable in the UI",
"type": "boolean",
"description": "Variables marked as hidden won't be displayed on the UI",
"default": false
},
"defaultValue": {
"$id": "#/definitions/form-variable/default-value",
"title": "Default value",
"type": [
"boolean",
"string"
],
"description": "Default value for variable. Can be overridden by the user in the UI"
},
"allowedValues": {
"$id": "#/definitions/form-variable/allowed-values",
"title": "Allowed values",
"type": "array",
"description": "Allowed string values for enum-type formVariables",
"items": {
"type": "string"
}
},
"dynamicOptions": {
"$id": "#/definitions/form-variable/dynamic-options",
"title": "Dynamic options",
"type": "object",
"description": "Parser and endpoint for handling dynamicEnum",
"propertyNames": {
"enum": [
"endpoint",
"parser"
]
},
"required": [
"endpoint",
"parser"
],
"properties": {
"endpoint": {
"$id": "#/definitions/endpoint",
"title": "Endpoint",
"description": "Properties that describe an HTTP request to an external endpoint",
"type": "object",
"propertyNames": {
"enum": [
"url",
"method",
"headers",
"hmacSignature"
]
},
"properties": {
"url": {
"$id": "#/definitions/endpoint/url",
"title": "URL",
"type": "string",
"description": "URL to send the request to. You can use {{template markup}} to inject a formVariable into the url."
},
"method": {
"$id": "#/definitions/endpoint/method",
"title": "HTTP method",
"description": "HTTP method to use when LaunchDarkly makes the request to your endpoint",
"enum": [
"POST",
"PUT",
"PATCH",
"GET",
"DELETE"
],
"type": "string"
},
"headers": {
"$id": "#/definitions/endpoint/headers",
"title": "HTTP headers",
"description": "Headers to send with the webhook request",
"type": "array",
"items": {
"$id": "#/definitions/endpoint/header/items",
"title": "Header items",
"description": "A name and value pair to send as headers with the hook request",
"type": "object",
"propertyNames": {
"enum": [
"name",
"value"
]
},
"properties": {
"name": {
"$id": "#/definitions/endpoint/header/items/name",
"title": "Name",
"type": "string",
"description": "Name of the header",
"maxLength": 50,
"pattern": "^[^\\s]*$"
},
"value": {
"$id": "#/definitions/endpoint/header/items/value",
"title": "Value",
"type": "string",
"description": "Value of the header. Form variables can be substituted in using {{variableName}}"
}
},
"required": [
"name",
"value"
]
},
"default": [
{
"name": "Content-Type",
"value": "application/json"
}
],
"examples": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{apiToken}}"
}
],
"minProperties": 1
},
"hmacSignature": {
"$id": "#/definitions/endpoint/hmac-signature",
"title": "HMAC signature",
"description": "Whether or not and how to configure HMAC validation on outgoing webhooks",
"type": "object",
"propertyNames": {
"enum": [
"headerName",
"hmacSecretFormVariableKey"
]
},
"properties": {
"headerName": {
"$id": "#/definitions/endpoint/hmac-signature/header-name",
"title": "HMAC signature header name",
"description": "The name of the HMAC signature header",
"type": "string"
},
"hmacSecretFormVariableKey": {
"$id": "#/definitions/endpoint/hmac-signature/secret-form-variable-field",
"title": "HMAC secret form variable key",
"description": "The name of the form variable field that corresponds to the HMAC encryption secret",
"type": "string"
}
}
}
},
"required": [
"url",
"method"
]
},
"parser": {
"$id": "#/definitions/form-variable/dynamic-options/parser",
"title": "Dynamic options parser",
"description": "Mapping of property names to location in JSON response",
"type": "object",
"required": [
"optionsPath",
"optionsItems"
],
"propertyNames": {
"enum": [
"optionsPath",
"optionsItems"
]
},
"properties": {
"optionsPath": {
"$id": "#/definitions/form-variable/dynamic-options/parser/options-path",
"title": "Options array path",
"description": "JSON path to the array containing options for parsing",
"type": "string"
},
"optionsItems": {
"$id": "#/definitions/form-variable/dynamic-options/parser/options-items",
"title": "Options array",
"propertyNames": {
"enum": [
"label",
"value"
]
},
"required": [
"label",
"value"
],
"properties": {
"label": {
"$id": "#/definitions/form-variable/dynamic-options/parser/options-items/label",
"title": "Label",
"description": "Relative JSON path to values for each item in the options array to be used as UI dropdown labels",
"type": "string"
},
"value": {
"$id": "#/definitions/form-variable/dynamic-options/parser/options-items/value",
"title": "Value",
"description": "Relative JSON path to values for each item in the options array to be used as dropdown values",
"type": "string"
}
}
}
}
}
}
},
"dependsOn": {
"$id": "#/definitions/form-variable/depends-on",
"title": "Depends on",
"type": "array",
"description": "Dependency configuration to control the state and visibility of the form field.",
"items": {
"type": "object",
"propertyNames": {
"enum": [
"variableKey",
"variableLocation",
"conditions",
"action"
]
},
"required": [
"variableKey",
"variableLocation",
"conditions",
"action"
],
"properties": {
"variableKey": {
"$id": "#/definitions/form-variable/depends-on/dependee-key",
"title": "Variable key",
"type": "string",
"description": "Key for the form variable that this form field depends on",
"maxLength": 20,
"pattern": "^[^\\s]*$"
},
"variableLocation": {
"$id": "#/definitions/form-variable/depends-on/dependee-key-location",
"title": "Variable Location",
"type": "string",
"description": "Which form variable type is the variable key defined or located in?",
"enum": [
"flagFormVariables",
"environmentFormVariables",
"formVariables"
]
},
"action": {
"$id": "#/definitions/form-variable/depends-on/action",
"title": "Action",
"type": "string",
"enum": [
"hideField",
"showField"
],
"description": "Action to be taken when your defined conditions evaluates to true"
},
"conditions": {
"$id": "#/definitions/form-variable/depends-on/conditions",
"title": "Conditions",
"type": "array",
"description": "Conditional configurations to be evaluated to decide whether an action should taken for the form field.",
"items": {
"type": "object",
"propertyNames": {
"enum": [
"operator",
"value"
]
},
"required": [
"operator",
"value"
],
"properties": {
"operator": {
"$id": "#/definitions/form-variable/depends-on/conditions/operator",
"title": "Operator",
"type": "string",
"description": "Name of the operator for evaluating a condition.",
"enum": [
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo",
"equalTo",
"notEqual",
"contains",
"startsWith",
"endsWith"
]
},
"value": {
"$id": "#/definitions/form-variable/depends-on/conditions/value",
"title": "Value",
"type": "string",
"maxLength": 250,
"description": "Target value that conditions are evaluated against"
}
}
}
}
}
}
}
},
"required": [
"key",
"name",
"type",
"description"
]
},
"default": []
},
"capabilities": {
"$id": "#/properties/capabilities",
"title": "Capabilities",
"description": "Specify which capabilities you'd like your integration to have",
"type": "object",
"propertyNames": {
"enum": [
"auditLogEventsHook",
"reservedCustomProperties",
"trigger",
"approval",
"featureStore",
"flagLink",
"hideConfiguration",
"externalConfigurationURL",
"externalConfigurationPages",
"syncedSegment"
]
},
"properties": {
"auditLogEventsHook": {
"$id": "#/properties/capability/audit-log-events-hook",
"title": "Audit log events hook",
"description": "This capability will enable LaunchDarkly to send audit log event webhooks to your endpoint.",
"type": "object",
"propertyNames": {
"enum": [
"endpoint",
"templates",
"defaultPolicy",
"includeErrorResponseBody",
"deliveryMethod",
"useStandardWebhookPayload"
]
},
"properties": {
"endpoint": {
"$id": "#/definitions/endpoint",
"title": "Endpoint",
"description": "Properties that describe an HTTP request to an external endpoint",
"type": "object",
"propertyNames": {
"enum": [
"url",
"method",
"headers",
"hmacSignature"
]
},
"properties": {
"url": {
"$id": "#/definitions/endpoint/url",
"title": "URL",
"type": "string",
"description": "URL to send the request to. You can use {{template markup}} to inject a formVariable into the url."
},
"method": {
"$id": "#/definitions/endpoint/method",
"title": "HTTP method",
"description": "HTTP method to use when LaunchDarkly makes the request to your endpoint",
"enum": [
"POST",
"PUT",
"PATCH",
"GET",
"DELETE"
],
"type": "string"
},
"headers": {
"$id": "#/definitions/endpoint/headers",
"title": "HTTP headers",
"description": "Headers to send with the webhook request",
"type": "array",
"items": {
"$id": "#/definitions/endpoint/header/items",
"title": "Header items",
"description": "A name and value pair to send as headers with the hook request",
"type": "object",
"propertyNames": {
"enum": [
"name",
"value"
]
},
"properties": {
"name": {
"$id": "#/definitions/endpoint/header/items/name",
"title": "Name",
"type": "string",
"description": "Name of the header",
"maxLength": 50,
"pattern": "^[^\\s]*$"
},
"value": {
"$id": "#/definitions/endpoint/header/items/value",
"title": "Value",
"type": "string",
"description": "Value of the header. Form variables can be substituted in using {{variableName}}"
}
},
"required": [
"name",
"value"
]
},
"default": [
{
"name": "Content-Type",
"value": "application/json"
}
],
"examples": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{apiToken}}"
}
],
"minProperties": 1
},
"hmacSignature": {
"$id": "#/definitions/endpoint/hmac-signature",
"title": "HMAC signature",
"description": "Whether or not and how to configure HMAC validation on outgoing webhooks",
"type": "object",
"propertyNames": {
"enum": [
"headerName",
"hmacSecretFormVariableKey"
]
},
"properties": {
"headerName": {
"$id": "#/definitions/endpoint/hmac-signature/header-name",
"title": "HMAC signature header name",
"description": "The name of the HMAC signature header",
"type": "string"
},
"hmacSecretFormVariableKey": {
"$id": "#/definitions/endpoint/hmac-signature/secret-form-variable-field",
"title": "HMAC secret form variable key",
"description": "The name of the form variable field that corresponds to the HMAC encryption secret",
"type": "string"
}
}
}
},
"required": [
"url",
"method"
]
},
"templates": {
"$id": "#/properties/capability/audit-log-events-hook/templates",
"title": "Webhook body template",
"description": "Templates to use for body of the webhook request",
"type": "object",
"propertyNames": {
"enum": [
"flag",
"project",
"environment",
"default",
"validation",
"member"
]
},
"properties": {
"flag": {
"$id": "#/properties/capability/audit-log-events-hook/templates/flag",
"title": "Flag template",
"description": "Template to use for flag events",
"type": "string"
},
"project": {
"$id": "#/properties/capability/audit-log-events-hook/templates/project",
"title": "Project template",
"description": "Template to use for project events",
"type": "string"
},
"environment": {
"$id": "#/properties/capability/audit-log-events-hook/templates/environment",
"title": "Environment template",
"description": "Template to use for environment events",
"type": "string"
},
"default": {
"$id": "#/properties/capability/audit-log-events-hook/templates/default",
"title": "default template",
"description": "Template to use if the event does not have a corresponding named template",
"type": "string"
},
"validation": {
"$id": "#/properties/capability/audit-log-events-hook/templates/validation",
"title": "validation template",
"description": "Template to use when sending test events with the 'validate connection' button",
"type": "string"
},
"member": {
"$id": "#/properties/capability/audit-log-events-hook/templates/member",
"title": "Member template",
"description": "Template to use for member events",
"type": "string"
}
}
},
"defaultPolicy": {
"$id": "#/properties/capability/audit-log-events-hook/default-policy",
"title": "Default Policy",
"description": "LaunchDarkly policy that allows you to filter events sent to your webhook. See https://docs.launchdarkly.com/home/members/role-policies for more information.",
"type": "array",
"minItems": 1,
"items": {
"$id": "#/properties/capability/audit-log-events-hook/policy",
"title": "Policy",
"description": "A LaunchDarkly policy. See https://docs.launchdarkly.com/home/members/role-policies for more information.",
"type": "object",
"propertyNames": {
"enum": [
"actions",
"effect",
"notActions",
"notResources",
"resources"
]
},
"properties": {
"actions": {
"$id": "#/properties/capability/audit-log-events-hook/policy/actions",
"title": "Actions",
"description": "A list of action specifiers defining the actions to which the statement applies. See https://docs.launchdarkly.com/home/members/role-actions for more information.",
"default": [
"*"
],
"examples": [
"updateOn",
"createFlag",
"updateRules",
"updateTargets"
],
"type": "array",
"items": {
"type": "string"
}
},
"effect": {
"$id": "#/properties/capability/audit-log-events-hook/policy/effect",
"title": "Effect",
"description": "This attribute defines whether the statement allows or denies access to the named resources and actions.",
"default": "allow",
"type": "string",
"enum": [
"allow",
"deny"
]
},
"notActions": {
"$id": "#/properties/capability/audit-log-events-hook/policy/not-actions",
"title": "Not actions",
"description": "A list of action specifiers defining the actions to which the statement does not apply. See https://docs.launchdarkly.com/home/members/role-actions for more information.",
"default": [
"*"
],
"examples": [
"createFlag",
"deleteFlag",
"cloneFlag"
],
"type": "array",
"items": {
"type": "string"
}
},
"notResources": {
"$id": "#/properties/capability/audit-log-events-hook/policy/not-resources",
"title": "Not resources",
"description": "A list of resource specifiers defining the resources to which the statement does not apply. See https://docs.launchdarkly.com/home/members/role-resources for more information.",
"default": [
"*"
],
"examples": [
"proj/*:env/production:flag/*"
],
"type": "array",
"items": {
"type": "string"
}
},
"resources": {
"$id": "#/properties/capability/audit-log-events-hook/policy/resources",
"title": "Resources",
"description": "A list of resource specifiers defining the resources to which the statement applies. See https://docs.launchdarkly.com/home/members/role-resources for more information.",
"default": [
"*"
],
"examples": [
"proj/*:env/production:flag/*"
],
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"includeErrorResponseBody": {
"$id": "#/properties/include-error-response-body",
"title": "Include error response body",
"type": "boolean",
"description": "Whether errors received from your endpoint should be displayed in the error log in LaunchDarkly UI",
"default": false
},
"deliveryMethod": {
"$id": "#/properties/delivery-method",
"title": "Delivery Method",
"type": "string",
"enum": [
"custom"
],
"description": "Describes how the audit log event will be delivered to the destination. Custom delivery method indicates a custom delivery implementation in LaunchDarkly will be used."