@@ -10,9 +10,7 @@ The `snap_kit_body` field has the following properties:
10
10
- ` snap_in_action_name ` : The name of the action this snap-kit represents.
11
11
- ` body ` : An object that holds the actual snap-kit content in the form of ` snaps ` .
12
12
13
- Example
14
-
15
- ``` json
13
+ ``` json Example
16
14
{
17
15
"object" : " <source_id>" ,
18
16
"body" : " Giphy" ,
@@ -54,9 +52,9 @@ Snap-kit generates payloads when a user interacts with an actionable snap. The p
54
52
- [Tag picker](#tag-picker)
55
53
- [User picker](#user-picker)
56
54
57
- All actionable snaps share the same base payload structure. The base payload has the following structure:
55
+ All actionable snaps share the same base payload structure.
58
56
59
- ```json
57
+ ```json Base payload structure
60
58
{
61
59
"type" : " <type of snap that generated the payload>" ,
62
60
"action_id" : " <the action identifier of the snap that generated the payload>" ,
@@ -255,9 +253,7 @@ Many elements share the same base properties. The base types these elements inhe
255
253
}
256
254
```
257
255
258
- _Example payload_
259
-
260
- ```json
256
+ ```json Example payload
261
257
{
262
258
"action_id" : " PRIMARY" ,
263
259
"action_type" : " remote" ,
@@ -739,9 +735,7 @@ _Example_
739
735
}
740
736
```
741
737
742
- _Example payload_
743
-
744
- ```json
738
+ ```json Example payload
745
739
{
746
740
"action_id" : " checkboxes" ,
747
741
"action_type" : " remote" ,
@@ -820,7 +814,6 @@ _Example_
820
814
821
815

822
816
823
-
824
817
```json
825
818
{
826
819
"element" : {
@@ -859,9 +852,7 @@ _Example_
859
852
}
860
853
```
861
854
862
- _Example payload_
863
-
864
- ```json
855
+ ```json Example payload
865
856
{
866
857
"type" : " plain_text_input" ,
867
858
"action_id" : " name" ,
@@ -921,9 +912,7 @@ _Example_
921
912
}
922
913
```
923
914
924
- _Example payload_
925
-
926
- ```json
915
+ ```json Example payload
927
916
{
928
917
"type" : " number_input" ,
929
918
"action_id" : " age" ,
@@ -987,9 +976,7 @@ _Example_
987
976
}
988
977
```
989
978
990
- _Example payload_
991
-
992
- ```json
979
+ ```json Example payload
993
980
{
994
981
"type" : " email_text_input" ,
995
982
"action_id" : " email" ,
@@ -1060,9 +1047,7 @@ _Example_
1060
1047
}
1061
1048
```
1062
1049
1063
- _Example payload_
1064
-
1065
- ```json
1050
+ ```json Example payload
1066
1051
{
1067
1052
"type" : " rich_text_input" ,
1068
1053
"action_id" : " notes" ,
@@ -1212,11 +1197,7 @@ _Example_
1212
1197
}
1213
1198
```
1214
1199
1215
- _Example payload_
1216
-
1217
- Standard string list input.
1218
-
1219
- ```json
1200
+ ```json Example payload: Standard string list input
1220
1201
{
1221
1202
"type" : " string_list" ,
1222
1203
"action_id" : " keywords" ,
@@ -1226,9 +1207,7 @@ _Example_
1226
1207
}
1227
1208
```
1228
1209
1229
- Multiline string list input.
1230
-
1231
- ```json
1210
+ ```json Example payload: Multiline string list input.
1232
1211
{
1233
1212
"type" : " string_list" ,
1234
1213
"action_id" : " multiline" ,
@@ -1301,9 +1280,7 @@ _Example_
1301
1280
}
1302
1281
```
1303
1282
1304
- _Example payload_
1305
-
1306
- ```json
1283
+ ```json Example payload
1307
1284
{
1308
1285
"type" : " number_list" ,
1309
1286
"action_id" : " numbers" ,
@@ -1369,9 +1346,7 @@ _Example_
1369
1346
}
1370
1347
```
1371
1348
1372
- _Example payload_
1373
-
1374
- ```json
1349
+ ```json Example payload
1375
1350
{
1376
1351
"type" : " email_list" ,
1377
1352
"action_id" : " emails" ,
@@ -1478,9 +1453,7 @@ _Example_
1478
1453
}
1479
1454
```
1480
1455
1481
- _Example payload_
1482
-
1483
- ```json
1456
+ ```json Example payload
1484
1457
{
1485
1458
"action_id" : " static_select" ,
1486
1459
"action_type" : " remote" ,
@@ -1594,9 +1567,7 @@ _Example_
1594
1567
}
1595
1568
```
1596
1569
1597
- _Example payload_
1598
-
1599
- ```json
1570
+ ```json Example payload
1600
1571
{
1601
1572
"action_id" : " multi_static_select" ,
1602
1573
"action_type" : " remote" ,
@@ -1695,9 +1666,7 @@ _Example_
1695
1666
}
1696
1667
```
1697
1668
1698
- _Example payload_
1699
-
1700
- ```json
1669
+ ```json Example payload
1701
1670
{
1702
1671
"action_id" : " in-app" ,
1703
1672
"action_type" : " remote" ,
@@ -1796,9 +1765,7 @@ _Example_
1796
1765
}
1797
1766
```
1798
1767
1799
- _Example payload_
1800
-
1801
- ```json
1768
+ ```json Example payload
1802
1769
{
1803
1770
"action_id" : " toggle" ,
1804
1771
"action_type" : " remote" ,
@@ -1891,9 +1858,7 @@ _Example_
1891
1858
}
1892
1859
```
1893
1860
1894
- _Example payload_
1895
-
1896
- ```json
1861
+ ```json Example payload
1897
1862
{
1898
1863
"action_id" : " upload" ,
1899
1864
"action_type" : " remote" ,
@@ -2421,9 +2386,7 @@ Inherits `type`, `action_id`, `action_type` and `timestamp` from [Base payload](
2421
2386
}
2422
2387
```
2423
2388
2424
- _Example payload_
2425
-
2426
- ```json
2389
+ ```json Example payload
2427
2390
{
2428
2391
"action_id" : " user_form" ,
2429
2392
"action_type" : " remote" ,
@@ -2664,9 +2627,7 @@ Inherits `type`, `action_id`, `action_type`, and `timestamp` from [Base payload]
2664
2627
}
2665
2628
```
2666
2629
2667
- _Example payload_
2668
-
2669
- ```json
2630
+ ```json Example payload
2670
2631
{
2671
2632
"action_id" : " part_picker" ,
2672
2633
"action_type" : " remote" ,
@@ -2749,9 +2710,7 @@ Inherits `type`, `action_id`, `action_type`, and `timestamp` from [Base payload]
2749
2710
}
2750
2711
```
2751
2712
2752
- _Example payload_
2753
-
2754
- ```json
2713
+ ```json Example payload
2755
2714
{
2756
2715
"action_id" : " tag_picker" ,
2757
2716
"action_type" : " remote" ,
@@ -2835,9 +2794,7 @@ Inherits `type`, `action_id`, `action_type`, and `timestamp` from [Base payload]
2835
2794
}
2836
2795
```
2837
2796
2838
- _Example payload_
2839
-
2840
- ```json
2797
+ ```json Example payload
2841
2798
{
2842
2799
"action_id" : " user_picker" ,
2843
2800
"action_type" : " remote" ,
0 commit comments