/
index.html
5768 lines (5333 loc) · 332 KB
/
index.html
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
<!DOCTYPE html>
<html lang="en">
<head>
<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-K7GFJTV');</script>
<!-- End Google Tag Manager -->
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Zapier Platform CLI Documentation</title>
<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.5.0/styles/agate.min.css">
<link href="//fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet">
<link rel="stylesheet" href="./docs.css">
<style>body {
font-family: 'Open Sans', Helvetica, arial, sans-serif;
background-color: #fff;
color: #5F6C72;
font-size: 14px;
font-weight: 400;
width: 100%;
height: 100%;
margin: 0;
padding: 0;
position: relative; }
img {
max-width: 100%; }
h1 {
color: #354147;
font-size: 28px;
font-weight: 400;
line-height: 1.3em;
padding: 20px 0; }
h2 {
color: #354147;
font-size: 20px;
line-height: 1.4em;
font-weight: 600;
padding: 1em 0; }
h3 {
color: #354147;
font-size: 15px;
line-height: 1.5em;
font-weight: 600;
padding: 0 0 0.5em 0; }
h4 {
color: #354147;
font-size: 0.9em;
letter-spacing: 1px;
line-height: 1.2em;
font-weight: 600;
padding: 0 0 10px;
text-transform: uppercase; }
a {
color: #499DF3;
text-decoration: none; }
a:hover {
text-decoration: underline; }
::-webkit-input-placeholder {
color: #969EA2; }
:-moz-placeholder {
color: #969EA2; }
::-moz-placeholder {
color: #969EA2; }
:-ms-input-placeholder {
color: #969EA2; }
p {
line-height: 1.6em;
margin: 0 0 15px; }
small {
font-size: 13px; }
i, em {
font-style: italic; }
strong {
font-weight: 600; }
sup, sub, .sup {
font-size: 13px;
vertical-align: baseline;
position: relative;
top: -0.4em; }
sup.small, sub.small, .sup.small {
font-size: 10px; }
sub {
top: 0.4em; }
pre {
border: none;
line-height: 20px;
font-family: 'Consolas','Liberation Mono',Courier,monospace; }
pre code {
display: block;
white-space: pre; /* no word wrap */
padding: 10px;
line-height: 1.7em; }
p code {
word-break: break-all;
display: inline; }
hr {
color: #DADFE2;
background: #DADFE2;
border: 0;
height: 1px; }
ul {
line-height: 1.75em;
margin: 0 0 20px; }
ol {
line-height: 1.75em;
list-style-type: decimal;
list-style-position: inside;
margin: 0 0 20px; }
blockquote {
border-left: 3px solid #ff4a00;
font-size: 14px;
font-style: italic;
line-height: 2em;
margin: 30px 0;
padding-left: 20px; }
blockquote p {
font-size: inherit;
font-style: inherit;
line-height: inherit; }
.docs-toc {
height: 100%;
width: 230px;
position: fixed;
padding: 40px 20px;
overflow-y: scroll;
overflow-x: hidden; }
.docs-toc ul {
margin: 0;
padding: 0 0 0 10px; }
.generated-by {
font-size: 12px;
color: #969EA2; }
.docs-main {}
.docs-code {
/* see media queries */ }
.docs-code pre {
background: #354147;
color: #ffffff;
line-height: 20px;
font-family: 'Consolas','Liberation Mono',Courier,monospace; }
.docs-code pre code {
display: block;
padding: 10px;
line-height: 1.7em; }
a code {
color: #499DF3;
background-color: #f2f4f9; }
/* targets bootstraps md width */
@media (min-width: 992px) {
.row-height {
display: table;
table-layout: fixed;
height: 100%;
width: 100%; }
.col-height {
display: table-cell;
float: none;
height: 100%; }
.docs-main {
margin-left: 230px; }
.docs-code {
background: #5F6C72;
color: #ffffff; }
}
@media (max-width: 992px) {
.docs-toc {
display: none; }
.is-empty {
display: none; }
}
</style>
</head>
<body>
<!-- Header -->
<div class="docs-header__platform">
<div class="docs-header__container">
<div class="docs-header__logo">
<svg fill="none" height="32" viewBox="0 0 177 32" width="177" xmlns="http://www.w3.org/2000/svg"><path d="M82.8896 25.23C82.0692 25.23 81.3178 25.0805 80.6354 24.7815C79.9607 24.4748 79.3933 24.0071 78.9333 23.3784H78.7953C78.8873 24.1144 78.9333 24.8122 78.9333 25.4715V30.6584H77.0242V12.395H78.5768L78.8413 14.1202H78.9333C79.424 13.4301 79.9952 12.9317 80.6469 12.6251C81.2986 12.3184 82.0462 12.165 82.8896 12.165C84.5611 12.165 85.8492 12.7362 86.7539 13.8787C87.6663 15.0211 88.1225 16.6235 88.1225 18.686C88.1225 20.7562 87.6586 22.3663 86.7309 23.5164C85.8108 24.6588 84.5304 25.23 82.8896 25.23ZM82.6136 13.7866C81.3255 13.7866 80.3939 14.1432 79.8189 14.8562C79.2438 15.5693 78.9486 16.704 78.9333 18.2605V18.686C78.9333 20.4572 79.2285 21.7261 79.8189 22.4928C80.4092 23.2519 81.3562 23.6314 82.6596 23.6314C83.7483 23.6314 84.5994 23.1905 85.2128 22.3088C85.8338 21.4271 86.1444 20.2118 86.1444 18.663C86.1444 17.0912 85.8338 15.8875 85.2128 15.0517C84.5994 14.2083 83.733 13.7866 82.6136 13.7866ZM93.3784 25H91.4693V7.10463H93.3784V25ZM105.178 25L104.799 23.2059H104.707C104.078 23.9956 103.449 24.5323 102.821 24.816C102.2 25.092 101.421 25.23 100.486 25.23C99.2362 25.23 98.2548 24.908 97.5417 24.2639C96.8363 23.6199 96.4836 22.7037 96.4836 21.5152C96.4836 18.9697 98.5193 17.6356 102.591 17.5129L104.73 17.4439V16.6619C104.73 15.6728 104.515 14.9444 104.086 14.4767C103.664 14.0013 102.985 13.7636 102.05 13.7636C101 13.7636 99.8112 14.0857 98.4848 14.7297L97.8982 13.2691C98.5193 12.9317 99.1978 12.6672 99.9339 12.4755C100.678 12.2839 101.421 12.188 102.165 12.188C103.668 12.188 104.78 12.5215 105.5 13.1886C106.229 13.8556 106.593 14.9252 106.593 16.3973V25H105.178ZM100.865 23.6544C102.054 23.6544 102.985 23.3285 103.66 22.6768C104.343 22.0251 104.684 21.1127 104.684 19.9396V18.801L102.775 18.8815C101.257 18.9352 100.16 19.1729 99.4854 19.5946C98.8183 20.0086 98.4848 20.6565 98.4848 21.5382C98.4848 22.2283 98.6918 22.7535 99.1058 23.1139C99.5275 23.4742 100.114 23.6544 100.865 23.6544ZM114.609 23.6544C114.946 23.6544 115.272 23.6314 115.587 23.5854C115.901 23.5317 116.15 23.4781 116.334 23.4244V24.885C116.127 24.9847 115.82 25.0652 115.414 25.1265C115.015 25.1955 114.655 25.23 114.333 25.23C111.895 25.23 110.676 23.9458 110.676 21.3772V13.8787H108.87V12.9586L110.676 12.165L111.481 9.47382H112.585V12.395H116.242V13.8787H112.585V21.2967C112.585 22.0558 112.765 22.6385 113.125 23.0449C113.486 23.4512 113.98 23.6544 114.609 23.6544ZM124.546 13.8787H121.337V25H119.428V13.8787H117.174V13.0161L119.428 12.326V11.6245C119.428 8.52691 120.781 6.97813 123.488 6.97813C124.155 6.97813 124.937 7.1123 125.834 7.38066L125.339 8.91027C124.603 8.67259 123.975 8.55375 123.453 8.55375C122.732 8.55375 122.2 8.79526 121.855 9.2783C121.51 9.75367 121.337 10.5204 121.337 11.5785V12.395H124.546V13.8787ZM137.726 18.686C137.726 20.7408 137.208 22.3471 136.173 23.5049C135.138 24.655 133.708 25.23 131.883 25.23C130.756 25.23 129.756 24.9655 128.882 24.4365C128.008 23.9074 127.333 23.1484 126.857 22.1593C126.382 21.1702 126.144 20.0125 126.144 18.686C126.144 16.6312 126.658 15.0326 127.686 13.8902C128.713 12.7401 130.139 12.165 131.964 12.165C133.727 12.165 135.127 12.7516 136.162 13.9247C137.204 15.0977 137.726 16.6849 137.726 18.686ZM128.123 18.686C128.123 20.2961 128.445 21.5229 129.089 22.3663C129.733 23.2097 130.68 23.6314 131.929 23.6314C133.179 23.6314 134.126 23.2135 134.77 22.3778C135.422 21.5344 135.748 20.3038 135.748 18.686C135.748 17.0836 135.422 15.8683 134.77 15.0402C134.126 14.2045 133.171 13.7866 131.906 13.7866C130.657 13.7866 129.714 14.1968 129.077 15.0172C128.441 15.8376 128.123 17.0606 128.123 18.686ZM146.834 12.165C147.394 12.165 147.896 12.211 148.341 12.303L148.077 14.0742C147.555 13.9592 147.095 13.9017 146.696 13.9017C145.677 13.9017 144.803 14.3157 144.074 15.1437C143.354 15.9718 142.993 17.0031 142.993 18.2375V25H141.084V12.395H142.66L142.878 14.7297H142.97C143.438 13.9093 144.001 13.2768 144.661 12.8321C145.32 12.3874 146.045 12.165 146.834 12.165ZM166.766 25V16.7999C166.766 15.7955 166.551 15.0441 166.121 14.5457C165.692 14.0397 165.025 13.7866 164.12 13.7866C162.932 13.7866 162.054 14.1278 161.487 14.8102C160.919 15.4926 160.636 16.543 160.636 17.9615V25H158.726V16.7999C158.726 15.7955 158.512 15.0441 158.082 14.5457C157.653 14.0397 156.982 13.7866 156.07 13.7866C154.874 13.7866 153.996 14.147 153.436 14.8677C152.884 15.5808 152.608 16.7539 152.608 18.387V25H150.699V12.395H152.251L152.562 14.1202H152.654C153.014 13.5068 153.52 13.0276 154.172 12.6826C154.831 12.3375 155.567 12.165 156.38 12.165C158.351 12.165 159.639 12.8781 160.245 14.3042H160.337C160.712 13.6448 161.257 13.1234 161.97 12.7401C162.683 12.3567 163.495 12.165 164.408 12.165C165.834 12.165 166.9 12.533 167.605 13.2691C168.318 13.9975 168.675 15.1667 168.675 16.7769V25H166.766Z" fill="#dadfe2"></path><path d="M41.4582 13.8944H39.7361C39.7007 13.7517 39.6743 13.5861 39.6568 13.3983C39.6217 13.0325 39.6217 12.6643 39.6568 12.2986C39.6743 12.1111 39.7007 11.9457 39.7361 11.8022H44.0279V25.5626C43.8131 25.6005 43.5965 25.6272 43.3789 25.6427C43.1628 25.6595 42.9462 25.6683 42.7295 25.6693C42.5219 25.6679 42.3144 25.659 42.1074 25.6427C41.8899 25.6271 41.6734 25.6002 41.4586 25.5622V13.8938V13.8941L41.4582 13.8944ZM56.3991 17.3549C56.3991 16.854 56.3328 16.3758 56.2007 15.9194C56.068 15.4637 55.8732 15.066 55.6178 14.726C55.3612 14.3866 55.0347 14.1136 54.6373 13.9081C54.24 13.7024 53.7675 13.5994 53.22 13.5994C52.1428 13.5994 51.317 13.9307 50.7431 14.5921C50.1692 15.2536 49.8205 16.1745 49.6967 17.3549H56.3992H56.3991ZM49.6703 19.3396C49.7057 20.8417 50.0898 21.9417 50.8227 22.6387C51.5554 23.336 52.6373 23.6852 54.0679 23.6852C55.3214 23.6852 56.5136 23.4613 57.6439 23.0143C57.7849 23.2825 57.8996 23.609 57.988 23.9934C58.0748 24.3678 58.128 24.7492 58.1469 25.1333C57.5645 25.3843 56.9238 25.5712 56.2266 25.6967C55.5286 25.8215 54.756 25.8844 53.9088 25.8844C52.6721 25.8844 51.6123 25.7095 50.7297 25.3612C49.8465 25.0121 49.118 24.5203 48.544 23.8858C47.9702 23.2512 47.5505 22.5 47.2856 21.6326C47.0209 20.7656 46.8881 19.8132 46.8881 18.7761C46.8881 17.7568 47.0161 16.8045 47.2722 15.9191C47.5279 15.0345 47.9217 14.2654 48.4509 13.6127C48.981 12.9598 49.6475 12.4414 50.4512 12.0569C51.2544 11.6725 52.2036 11.48 53.299 11.48C54.2349 11.48 55.0561 11.6411 55.7628 11.9629C56.4689 12.2847 57.0607 12.7274 57.5377 13.2907C58.0144 13.8541 58.3764 14.5247 58.6238 15.3021C58.8708 16.0803 58.9949 16.9251 58.9949 17.8373C58.9949 18.0877 58.9855 18.3513 58.968 18.6283C58.9535 18.8655 58.9359 19.1024 58.9152 19.3391H49.6698L49.6701 19.3395L49.6703 19.3396ZM61.884 11.8022C62.0683 11.7683 62.2539 11.7415 62.4403 11.7219C62.6164 11.7044 62.8023 11.6953 62.9966 11.6953C63.1909 11.6953 63.3849 11.7044 63.5794 11.7219C63.7736 11.74 63.9503 11.7669 64.1093 11.8022C64.1618 12.0705 64.2149 12.4241 64.2677 12.8617C64.3206 13.2999 64.3475 13.6707 64.3475 13.9748C64.7183 13.3671 65.2084 12.8392 65.8175 12.392C66.4269 11.9453 67.2083 11.7214 68.1618 11.7214C68.3031 11.7214 68.4487 11.7262 68.5989 11.7352C68.7274 11.7421 68.8559 11.7553 68.983 11.775C69.0181 11.9362 69.0452 12.1063 69.0626 12.2849C69.08 12.4635 69.0889 12.6514 69.0889 12.848C69.0889 13.0627 69.0758 13.2865 69.0494 13.5184C69.0239 13.7426 68.993 13.9662 68.9568 14.1889C68.8137 14.1532 68.6668 14.1352 68.5194 14.1353H68.1616C67.6848 14.1353 67.23 14.2024 66.7973 14.3363C66.3643 14.4707 65.976 14.7077 65.6316 15.0471C65.2876 15.3871 65.0136 15.8521 64.8109 16.4423C64.6073 17.0324 64.506 17.7924 64.506 18.7221V25.5622C64.2912 25.6 64.0745 25.627 63.8569 25.6425C63.6188 25.6604 63.4023 25.6691 63.2081 25.6691C62.9915 25.6682 62.775 25.6594 62.559 25.6425C62.3327 25.6259 62.1072 25.5991 61.8833 25.5624V11.8023L61.884 11.8022ZM43.2914 4.4547C43.2915 4.77575 43.2342 5.09417 43.1224 5.39461C42.8256 5.50779 42.5111 5.5658 42.1939 5.56586H42.19C41.8728 5.5659 41.5583 5.50794 41.2615 5.39475C41.1495 5.09426 41.0922 4.77573 41.0922 4.45456V4.45037C41.0922 4.11948 41.1522 3.80259 41.2608 3.51018C41.5576 3.39684 41.8723 3.33886 42.1896 3.33907H42.1932C42.5201 3.33907 42.833 3.39979 43.1218 3.51018C43.2336 3.81068 43.2909 4.12921 43.2908 4.45037V4.45456H43.2912L43.2914 4.4547ZM46.5284 3.71039H43.9616L45.7764 1.87268C45.4911 1.46687 45.1407 1.11221 44.7398 0.823365L42.9247 2.66107V0.0619797C42.6834 0.0208725 42.439 0.000141251 42.1943 0H42.1896C41.9406 0 41.6967 0.021546 41.459 0.0619797V2.66107L39.6435 0.823225C39.4436 0.967313 39.2559 1.12812 39.0825 1.30395L39.0817 1.30479C38.9083 1.48049 38.7496 1.67049 38.6073 1.87282L40.4228 3.71039H37.8555C37.8555 3.71039 37.7944 4.19867 37.7944 4.45107V4.45414C37.7944 4.70654 37.8155 4.9539 37.8556 5.19468H40.423L38.6072 7.03211C38.8928 7.43787 39.2432 7.79259 39.6439 8.08171L41.4592 6.24414V8.84337C41.6966 8.88367 41.9401 8.90493 42.1888 8.90521H42.195C42.4395 8.90498 42.6835 8.8843 42.9246 8.84337V6.24414L44.74 8.08213C44.9399 7.93791 45.1277 7.77711 45.3014 7.6014H45.3018C45.4751 7.42551 45.6337 7.23537 45.776 7.03295L43.9612 5.19482H46.5286C46.5684 4.95418 46.5894 4.70766 46.5894 4.45582V4.44939C46.5894 4.20175 46.5689 3.95481 46.5286 3.71067V3.71039H46.5284ZM0 25.1873L7.15269 13.9212H0.847589C0.794805 13.5994 0.768413 13.2421 0.768413 12.8485C0.768413 12.4732 0.795219 12.1241 0.848142 11.802H11.0471L11.1798 12.1514L3.97416 23.4437H10.7292C10.7821 23.8015 10.8088 24.1678 10.8088 24.5431C10.8088 24.9013 10.7822 25.2409 10.7293 25.5626H0.132652L0 25.1868V25.1873ZM20.6365 19.098C20.3716 19.0626 20.0359 19.0272 19.6298 18.991C19.2236 18.9556 18.8792 18.9374 18.5971 18.9374C17.5019 18.9374 16.6674 19.1431 16.0938 19.5544C15.5194 19.966 15.233 20.5915 15.233 21.432C15.233 21.9684 15.3297 22.3887 15.5241 22.6926C15.7181 22.997 15.9612 23.229 16.2526 23.39C16.5442 23.5509 16.8661 23.6494 17.2192 23.6852C17.5722 23.7209 17.908 23.7386 18.2258 23.7386C18.632 23.7386 19.0514 23.7163 19.4842 23.6715C19.9167 23.6271 20.3008 23.5598 20.6366 23.4704V19.098H20.6365ZM20.6365 16.4965C20.6365 15.4411 20.3716 14.7079 19.8419 14.2966C19.3119 13.8853 18.5437 13.6796 17.5371 13.6796C16.9185 13.6796 16.3405 13.7291 15.802 13.8274C15.2691 13.9242 14.7426 14.0539 14.2254 14.2159C13.8896 13.6257 13.7224 12.9199 13.7224 12.0968C14.3221 11.9004 14.9843 11.7484 15.7087 11.6411C16.4328 11.5337 17.1303 11.48 17.8017 11.48C19.5676 11.48 20.9098 11.8871 21.8283 12.7007C22.7463 13.5149 23.2059 14.8157 23.2059 16.6036V25.2139C22.5874 25.3568 21.8371 25.5043 20.9541 25.6564C20.0614 25.809 19.1575 25.8853 18.252 25.8844C17.3868 25.8844 16.605 25.8043 15.9077 25.6432C15.2099 25.4819 14.6182 25.2232 14.1327 24.8651C13.6465 24.5077 13.2718 24.0516 13.0065 23.4974C12.7417 22.943 12.6092 22.2725 12.6092 21.4856C12.6092 20.7169 12.7637 20.0417 13.0728 19.4602C13.3766 18.8857 13.8073 18.3901 14.3314 18.0119C14.8611 17.628 15.4704 17.3414 16.1592 17.154C16.8482 16.9661 17.5719 16.8721 18.3314 16.8721C18.8965 16.8721 19.3601 16.8858 19.7223 16.9126C20.084 16.9392 20.3888 16.9705 20.6362 17.0064V16.4967L20.6365 16.4965ZM28.6895 23.309C29.024 23.4341 29.3702 23.524 29.7228 23.5773C30.076 23.6312 30.5348 23.6579 31.1005 23.6579C31.7361 23.6579 32.3187 23.5554 32.8484 23.3497C33.3785 23.1445 33.8331 22.8267 34.2128 22.3973C34.5925 21.9684 34.8927 21.4278 35.1135 20.7744C35.3341 20.1221 35.4448 19.349 35.4448 18.4544C35.4448 17.024 35.1839 15.8885 34.6633 15.0479C34.1419 14.2076 33.2898 13.7873 32.107 13.7873C31.6655 13.7873 31.2413 13.8676 30.8357 14.0288C30.4289 14.1897 30.0672 14.4312 29.7492 14.753C29.4314 15.0748 29.1754 15.4819 28.9812 15.9736C28.7864 16.4658 28.6897 17.0509 28.6897 17.7305V23.3094V23.3091L28.6895 23.309ZM26.0669 11.8019C26.2465 11.7661 26.4275 11.7393 26.6099 11.7216C26.7993 11.7038 26.9894 11.695 27.1796 11.695C27.3557 11.695 27.541 11.7042 27.7357 11.7216C27.9297 11.7398 28.1151 11.7668 28.292 11.802C28.3094 11.8384 28.3318 11.9496 28.3583 12.1375C28.3846 12.3254 28.4111 12.5265 28.4378 12.7408C28.4643 12.9556 28.4907 13.1617 28.5172 13.3578C28.5437 13.5548 28.557 13.68 28.557 13.7336C28.7332 13.4478 28.9453 13.1703 29.1926 12.9021C29.44 12.6338 29.7361 12.3924 30.0804 12.1781C30.4248 11.9633 30.8131 11.7936 31.246 11.6683C31.6785 11.5432 32.1597 11.4801 32.6897 11.4801C33.4842 11.4801 34.2217 11.6144 34.9019 11.8828C35.5815 12.1514 36.1639 12.5665 36.6499 13.1299C37.1353 13.6933 37.5149 14.4087 37.7889 15.2757C38.0625 16.1437 38.1993 17.1673 38.1993 18.3473C38.1993 20.7075 37.5678 22.5543 36.3048 23.8863C35.0419 25.2186 33.2543 25.8844 30.9407 25.8844C30.552 25.8844 30.1549 25.8576 29.7487 25.804C29.3421 25.7501 28.9892 25.6785 28.6888 25.5895V31.893C28.4651 31.9298 28.2398 31.9567 28.0137 31.9734C27.7751 31.9909 27.5585 32 27.3643 32C27.1477 31.9991 26.9313 31.9902 26.7154 31.9734C26.4979 31.9578 26.2813 31.931 26.0665 31.893V11.802L26.0669 11.8019Z" fill="#ffffff"></path></svg>
</div>
<div class="docs-header__links">
<a href="https://zapier.com/app/developer">My Integrations</a>
<a href="https://zapier.com/developer/zap-templates">Zap Templates</a>
</div>
</div>
</div>
<!-- End Header -->
<!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-K7GFJTV"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager (noscript) -->
<div class="docs-toc">
<ul>
<li><a href="#getting-started">Getting Started</a><ul>
<li><a href="#what-is-an-app">What is an App?</a></li>
<li><a href="#how-does-zapier-platform-cli-work">How does Zapier Platform CLI Work?</a></li>
<li><a href="#zapier-platform-cli-vs-ui">Zapier Platform CLI vs UI</a></li>
<li><a href="#requirements">Requirements</a></li>
<li><a href="#quick-setup-guide">Quick Setup Guide</a></li>
<li><a href="#tutorial">Tutorial</a></li>
</ul>
</li>
<li><a href="#creating-a-local-app">Creating a Local App</a><ul>
<li><a href="#local-project-structure">Local Project Structure</a></li>
<li><a href="#local-app-definition">Local App Definition</a></li>
</ul>
</li>
<li><a href="#registering-an-app">Registering an App</a></li>
<li><a href="#deploying-an-app-version">Deploying an App Version</a><ul>
<li><a href="#private-app-version-default">Private App Version (default)</a></li>
<li><a href="#sharing-an-app-version">Sharing an App Version</a></li>
<li><a href="#promoting-an-app-version">Promoting an App Version</a></li>
</ul>
</li>
<li><a href="#converting-an-existing-app">Converting an Existing App</a></li>
<li><a href="#authentication">Authentication</a><ul>
<li><a href="#basic">Basic</a></li>
<li><a href="#digest">Digest</a></li>
<li><a href="#custom">Custom</a></li>
<li><a href="#session">Session</a></li>
<li><a href="#oauth1">OAuth1</a></li>
<li><a href="#oauth2">OAuth2</a></li>
<li><a href="#oauth2-with-pkce">OAuth2 with PKCE</a></li>
<li><a href="#connection-label">Connection Label</a></li>
</ul>
</li>
<li><a href="#resources">Resources</a><ul>
<li><a href="#resource-definition">Resource Definition</a></li>
</ul>
</li>
<li><a href="#triggerssearchescreates">Triggers/Searches/Creates</a><ul>
<li><a href="#return-types">Return Types</a><ul>
<li><a href="#returning-line-items-array-of-objects">Returning Line Items (Array of Objects)</a></li>
</ul>
</li>
<li><a href="#fallback-sample">Fallback Sample</a></li>
</ul>
</li>
<li><a href="#input-fields">Input Fields</a><ul>
<li><a href="#customdynamic-fields">Custom/Dynamic Fields</a></li>
<li><a href="#dynamic-dropdowns">Dynamic Dropdowns</a></li>
<li><a href="#search-powered-fields">Search-Powered Fields</a></li>
<li><a href="#computed-fields">Computed Fields</a></li>
<li><a href="#nested--children-line-item-fields">Nested & Children (Line Item) Fields</a></li>
</ul>
</li>
<li><a href="#output-fields">Output Fields</a><ul>
<li><a href="#nested--children-line-item-fields-1">Nested & Children (Line Item) Fields</a></li>
</ul>
</li>
<li><a href="#z-object">Z Object</a><ul>
<li><a href="#zrequesturl-options"><code>z.request([url], options)</code></a></li>
<li><a href="#zconsole"><code>z.console</code></a></li>
<li><a href="#zdehydratefunc-inputdata"><code>z.dehydrate(func, inputData)</code></a></li>
<li><a href="#zdehydratefilefunc-inputdata"><code>z.dehydrateFile(func, inputData)</code></a></li>
<li><a href="#zstashfilebufferstringstream-knownlength-filename-contenttype"><code>z.stashFile(bufferStringStream, [knownLength], [filename], [contentType])</code></a></li>
<li><a href="#zjson"><code>z.JSON</code></a></li>
<li><a href="#zhash"><code>z.hash()</code></a></li>
<li><a href="#zerrors"><code>z.errors</code></a></li>
<li><a href="#zcursor"><code>z.cursor</code></a></li>
<li><a href="#zgeneratecallbackurl"><code>z.generateCallbackUrl()</code></a></li>
</ul>
</li>
<li><a href="#bundle-object">Bundle Object</a><ul>
<li><a href="#bundleauthdata"><code>bundle.authData</code></a></li>
<li><a href="#bundleinputdata"><code>bundle.inputData</code></a></li>
<li><a href="#bundleinputdataraw"><code>bundle.inputDataRaw</code></a></li>
<li><a href="#bundlemeta"><code>bundle.meta</code></a></li>
<li><a href="#bundlerawrequest"><code>bundle.rawRequest</code></a></li>
<li><a href="#bundlecleanedrequest"><code>bundle.cleanedRequest</code></a></li>
<li><a href="#bundleoutputdata"><code>bundle.outputData</code></a></li>
<li><a href="#bundletargeturl"><code>bundle.targetUrl</code></a></li>
<li><a href="#bundlesubscribedata"><code>bundle.subscribeData</code></a></li>
</ul>
</li>
<li><a href="#environment">Environment</a><ul>
<li><a href="#defining-environment-variables">Defining Environment Variables</a></li>
<li><a href="#accessing-environment-variables">Accessing Environment Variables</a></li>
</ul>
</li>
<li><a href="#making-http-requests">Making HTTP Requests</a><ul>
<li><a href="#shorthand-http-requests">Shorthand HTTP Requests</a></li>
<li><a href="#manual-http-requests">Manual HTTP Requests</a><ul>
<li><a href="#post-and-put-requests">POST and PUT Requests</a></li>
</ul>
</li>
<li><a href="#using-http-middleware">Using HTTP middleware</a><ul>
<li><a href="#error-response-handling">Error Response Handling</a></li>
</ul>
</li>
<li><a href="#http-request-options">HTTP Request Options</a></li>
<li><a href="#http-response-object">HTTP Response Object</a></li>
</ul>
</li>
<li><a href="#dehydration">Dehydration</a><ul>
<li><a href="#merging-hydrated-data">Merging Hydrated Data</a></li>
<li><a href="#file-dehydration">File Dehydration</a></li>
</ul>
</li>
<li><a href="#stashing-files">Stashing Files</a></li>
<li><a href="#logging">Logging</a><ul>
<li><a href="#console-logging">Console Logging</a></li>
<li><a href="#viewing-console-logs">Viewing Console Logs</a></li>
<li><a href="#viewing-bundle-logs">Viewing Bundle Logs</a></li>
<li><a href="#http-logging">HTTP Logging</a></li>
<li><a href="#viewing-http-logs">Viewing HTTP Logs</a></li>
</ul>
</li>
<li><a href="#error-handling">Error Handling</a><ul>
<li><a href="#general-errors">General Errors</a></li>
<li><a href="#halting-execution">Halting Execution</a></li>
<li><a href="#stale-authentication-credentials">Stale Authentication Credentials</a></li>
<li><a href="#handling-throttled-requests">Handling Throttled Requests</a></li>
</ul>
</li>
<li><a href="#testing">Testing</a><ul>
<li><a href="#writing-unit-tests">Writing Unit Tests</a></li>
<li><a href="#using-the-z-object-in-tests">Using the <code>z</code> Object in Tests</a></li>
<li><a href="#mocking-requests">Mocking Requests</a></li>
<li><a href="#running-unit-tests">Running Unit Tests</a></li>
<li><a href="#testing--environment-variables">Testing & Environment Variables</a></li>
<li><a href="#testing-in-your-ci">Testing in Your CI</a></li>
<li><a href="#debugging-tests">Debugging Tests</a></li>
</ul>
</li>
<li><a href="#using-npm-modules">Using <code>npm</code> Modules</a></li>
<li><a href="#building-native-packages-with-docker">Building Native Packages with Docker</a></li>
<li><a href="#using-transpilers">Using Transpilers</a></li>
<li><a href="#faqs">FAQs</a><ul>
<li><a href="#why-doesnt-zapier-support-newer-versions-of-nodejs">Why doesn't Zapier support newer versions of Node.js?</a></li>
<li><a href="#how-do-i-manually-set-the-nodejs-version-to-run-my-app-with">How do I manually set the Node.js version to run my app with?</a></li>
<li><a href="#when-to-use-placeholders-or-curlies">When to use placeholders or curlies?</a></li>
<li><a href="#does-zapier-support-xml-soap-apis">Does Zapier support XML (SOAP) APIs?</a></li>
<li><a href="#is-it-possible-to-iterate-over-pages-in-a-polling-trigger">Is it possible to iterate over pages in a polling trigger?</a></li>
<li><a href="#how-do-search-powered-fields-relate-to-dynamic-dropdowns-and-why-are-they-both-required-together">How do search-powered fields relate to dynamic dropdowns and why are they both required together?</a></li>
<li><a href="#whats-the-deal-with-pagination-when-is-it-used-and-how-does-it-work">What's the deal with pagination? When is it used and how does it work?</a></li>
<li><a href="#how-does-deduplication-work">How does deduplication work?</a></li>
<li><a href="#why-are-my-triggers-complaining-if-i-dont-provide-an-explicit-id-field">Why are my triggers complaining if I don't provide an explicit <code>id</code> field?</a></li>
<li><a href="#node-x-no-longer-supported">Node X No Longer Supported</a></li>
<li><a href="#what-analytics-are-collected">What Analytics are Collected?</a></li>
<li><a href="#whats-the-difference-between-an-app-and-an-integration">What's the Difference Between an "App" and an "Integration"?</a></li>
</ul>
</li>
<li><a href="#command-line-tab-completion">Command Line Tab Completion</a></li>
<li><a href="#the-zapier-platform-packages">The Zapier Platform Packages</a><ul>
<li><a href="#updating-these-packages">Updating These Packages</a></li>
</ul>
</li>
<li><a href="#get-help">Get Help!</a></li>
<li><a href="#developing-on-the-cli">Developing on the CLI</a></li>
</ul>
<hr />
<small><a class="generated-by" href="https://github.com/zapier/litdoc">generated by litdoc</a></small>
</div>
<div class="docs-main container-fluid">
<div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h1 align="center">
<img alt="Zapier Logo" src="https://cdn.zappy.app/1cd66b15407db2d9a01fbe8d600772fe.svg" width="300px">
<br>
Platform CLI
<br>
<br>
</h1>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<p align="center">
<a href="https://www.npmjs.com/package/zapier-platform-cli"><img src="https://img.shields.io/npm/v/zapier-platform-cli.svg" alt="npm version"></a>
</p><p>Zapier is a platform for creating integrations and workflows. This CLI is your gateway to creating custom applications on the Zapier platform.</p><p>You may find some documents on the Zapier site duplicate or outdated. The most up-to-date contents are always available on GitHub:</p><ul>
<li><a href="https://github.com/zapier/zapier-platform/blob/main/packages/cli/README.md">Latest CLI Docs</a></li>
<li><a href="https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md">Latest CLI Reference</a></li>
<li><a href="https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md">Latest Schema Docs</a></li>
</ul><p>Our code is updated frequently. To see a full list of changes, look no further than <a href="https://github.com/zapier/zapier-platform/blob/main/CHANGELOG.md">the CHANGELOG</a>.</p><p>This doc describes the latest CLI version (<strong>15.1.0</strong>), as of this writing. If you're using an older version of the CLI, you may want to check out these historical releases:</p><ul>
<li>CLI Docs: <a href="https://github.com/zapier/zapier-platform/blob/zapier-platform-cli@14.1.2/packages/cli/README.md">14.x</a>, <a href="https://github.com/zapier/zapier-platform/blob/zapier-platform-cli@13.0.0/packages/cli/README.md">13.x</a></li>
<li>CLI Reference: <a href="https://github.com/zapier/zapier-platform/blob/zapier-platform-cli@14.1.2/packages/cli/docs/cli.md">14.x</a>, <a href="https://github.com/zapier/zapier-platform/blob/zapier-platform-cli@13.0.0/packages/cli/docs/cli.md">13.x</a></li>
<li>Schema Docs: <a href="https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@14.1.2/packages/schema/docs/build/schema.md">14.x</a>, <a href="https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@13.0.0/packages/schema/docs/build/schema.md">13.x</a></li>
</ul>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h2 id="table-of-contents">Table of Contents</h2>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<ul>
<li><a href="#getting-started">Getting Started</a><ul>
<li><a href="#what-is-an-app">What is an App?</a></li>
<li><a href="#how-does-zapier-platform-cli-work">How does Zapier Platform CLI Work?</a></li>
<li><a href="#zapier-platform-cli-vs-ui">Zapier Platform CLI vs UI</a></li>
<li><a href="#requirements">Requirements</a></li>
<li><a href="#quick-setup-guide">Quick Setup Guide</a></li>
<li><a href="#tutorial">Tutorial</a></li>
</ul>
</li>
<li><a href="#creating-a-local-app">Creating a Local App</a><ul>
<li><a href="#local-project-structure">Local Project Structure</a></li>
<li><a href="#local-app-definition">Local App Definition</a></li>
</ul>
</li>
<li><a href="#registering-an-app">Registering an App</a></li>
<li><a href="#deploying-an-app-version">Deploying an App Version</a><ul>
<li><a href="#private-app-version-default">Private App Version (default)</a></li>
<li><a href="#sharing-an-app-version">Sharing an App Version</a></li>
<li><a href="#promoting-an-app-version">Promoting an App Version</a></li>
</ul>
</li>
<li><a href="#converting-an-existing-app">Converting an Existing App</a></li>
<li><a href="#authentication">Authentication</a><ul>
<li><a href="#basic">Basic</a></li>
<li><a href="#digest">Digest</a></li>
<li><a href="#custom">Custom</a></li>
<li><a href="#session">Session</a></li>
<li><a href="#oauth1">OAuth1</a></li>
<li><a href="#oauth2">OAuth2</a></li>
<li><a href="#oauth2-with-pkce">OAuth2 with PKCE</a></li>
<li><a href="#connection-label">Connection Label</a></li>
</ul>
</li>
<li><a href="#resources">Resources</a><ul>
<li><a href="#resource-definition">Resource Definition</a></li>
</ul>
</li>
<li><a href="#triggerssearchescreates">Triggers/Searches/Creates</a><ul>
<li><a href="#return-types">Return Types</a><ul>
<li><a href="#returning-line-items-array-of-objects">Returning Line Items (Array of Objects)</a></li>
</ul>
</li>
<li><a href="#fallback-sample">Fallback Sample</a></li>
</ul>
</li>
<li><a href="#input-fields">Input Fields</a><ul>
<li><a href="#customdynamic-fields">Custom/Dynamic Fields</a></li>
<li><a href="#dynamic-dropdowns">Dynamic Dropdowns</a></li>
<li><a href="#search-powered-fields">Search-Powered Fields</a></li>
<li><a href="#computed-fields">Computed Fields</a></li>
<li><a href="#nested--children-line-item-fields">Nested & Children (Line Item) Fields</a></li>
</ul>
</li>
<li><a href="#output-fields">Output Fields</a><ul>
<li><a href="#nested--children-line-item-fields-1">Nested & Children (Line Item) Fields</a></li>
</ul>
</li>
<li><a href="#z-object">Z Object</a><ul>
<li><a href="#zrequesturl-options"><code>z.request([url], options)</code></a></li>
<li><a href="#zconsole"><code>z.console</code></a></li>
<li><a href="#zdehydratefunc-inputdata"><code>z.dehydrate(func, inputData)</code></a></li>
<li><a href="#zdehydratefilefunc-inputdata"><code>z.dehydrateFile(func, inputData)</code></a></li>
<li><a href="#zstashfilebufferstringstream-knownlength-filename-contenttype"><code>z.stashFile(bufferStringStream, [knownLength], [filename], [contentType])</code></a></li>
<li><a href="#zjson"><code>z.JSON</code></a></li>
<li><a href="#zhash"><code>z.hash()</code></a></li>
<li><a href="#zerrors"><code>z.errors</code></a></li>
<li><a href="#zcursor"><code>z.cursor</code></a></li>
<li><a href="#zgeneratecallbackurl"><code>z.generateCallbackUrl()</code></a></li>
</ul>
</li>
<li><a href="#bundle-object">Bundle Object</a><ul>
<li><a href="#bundleauthdata"><code>bundle.authData</code></a></li>
<li><a href="#bundleinputdata"><code>bundle.inputData</code></a></li>
<li><a href="#bundleinputdataraw"><code>bundle.inputDataRaw</code></a></li>
<li><a href="#bundlemeta"><code>bundle.meta</code></a></li>
<li><a href="#bundlerawrequest"><code>bundle.rawRequest</code></a></li>
<li><a href="#bundlecleanedrequest"><code>bundle.cleanedRequest</code></a></li>
<li><a href="#bundleoutputdata"><code>bundle.outputData</code></a></li>
<li><a href="#bundletargeturl"><code>bundle.targetUrl</code></a></li>
<li><a href="#bundlesubscribedata"><code>bundle.subscribeData</code></a></li>
</ul>
</li>
<li><a href="#environment">Environment</a><ul>
<li><a href="#defining-environment-variables">Defining Environment Variables</a></li>
<li><a href="#accessing-environment-variables">Accessing Environment Variables</a></li>
</ul>
</li>
<li><a href="#making-http-requests">Making HTTP Requests</a><ul>
<li><a href="#shorthand-http-requests">Shorthand HTTP Requests</a></li>
<li><a href="#manual-http-requests">Manual HTTP Requests</a><ul>
<li><a href="#post-and-put-requests">POST and PUT Requests</a></li>
</ul>
</li>
<li><a href="#using-http-middleware">Using HTTP middleware</a><ul>
<li><a href="#error-response-handling">Error Response Handling</a></li>
</ul>
</li>
<li><a href="#http-request-options">HTTP Request Options</a></li>
<li><a href="#http-response-object">HTTP Response Object</a></li>
</ul>
</li>
<li><a href="#dehydration">Dehydration</a><ul>
<li><a href="#merging-hydrated-data">Merging Hydrated Data</a></li>
<li><a href="#file-dehydration">File Dehydration</a></li>
</ul>
</li>
<li><a href="#stashing-files">Stashing Files</a></li>
<li><a href="#logging">Logging</a><ul>
<li><a href="#console-logging">Console Logging</a></li>
<li><a href="#viewing-console-logs">Viewing Console Logs</a></li>
<li><a href="#viewing-bundle-logs">Viewing Bundle Logs</a></li>
<li><a href="#http-logging">HTTP Logging</a></li>
<li><a href="#viewing-http-logs">Viewing HTTP Logs</a></li>
</ul>
</li>
<li><a href="#error-handling">Error Handling</a><ul>
<li><a href="#general-errors">General Errors</a></li>
<li><a href="#halting-execution">Halting Execution</a></li>
<li><a href="#stale-authentication-credentials">Stale Authentication Credentials</a></li>
<li><a href="#handling-throttled-requests">Handling Throttled Requests</a></li>
</ul>
</li>
<li><a href="#testing">Testing</a><ul>
<li><a href="#writing-unit-tests">Writing Unit Tests</a></li>
<li><a href="#using-the-z-object-in-tests">Using the <code>z</code> Object in Tests</a></li>
<li><a href="#mocking-requests">Mocking Requests</a></li>
<li><a href="#running-unit-tests">Running Unit Tests</a></li>
<li><a href="#testing--environment-variables">Testing & Environment Variables</a></li>
<li><a href="#testing-in-your-ci">Testing in Your CI</a></li>
<li><a href="#debugging-tests">Debugging Tests</a></li>
</ul>
</li>
<li><a href="#using-npm-modules">Using <code>npm</code> Modules</a></li>
<li><a href="#building-native-packages-with-docker">Building Native Packages with Docker</a></li>
<li><a href="#using-transpilers">Using Transpilers</a></li>
<li><a href="#faqs">FAQs</a><ul>
<li><a href="#why-doesnt-zapier-support-newer-versions-of-nodejs">Why doesn't Zapier support newer versions of Node.js?</a></li>
<li><a href="#how-do-i-manually-set-the-nodejs-version-to-run-my-app-with">How do I manually set the Node.js version to run my app with?</a></li>
<li><a href="#when-to-use-placeholders-or-curlies">When to use placeholders or curlies?</a></li>
<li><a href="#does-zapier-support-xml-soap-apis">Does Zapier support XML (SOAP) APIs?</a></li>
<li><a href="#is-it-possible-to-iterate-over-pages-in-a-polling-trigger">Is it possible to iterate over pages in a polling trigger?</a></li>
<li><a href="#how-do-search-powered-fields-relate-to-dynamic-dropdowns-and-why-are-they-both-required-together">How do search-powered fields relate to dynamic dropdowns and why are they both required together?</a></li>
<li><a href="#whats-the-deal-with-pagination-when-is-it-used-and-how-does-it-work">What's the deal with pagination? When is it used and how does it work?</a></li>
<li><a href="#how-does-deduplication-work">How does deduplication work?</a></li>
<li><a href="#why-are-my-triggers-complaining-if-i-dont-provide-an-explicit-id-field">Why are my triggers complaining if I don't provide an explicit <code>id</code> field?</a></li>
<li><a href="#node-x-no-longer-supported">Node X No Longer Supported</a></li>
<li><a href="#what-analytics-are-collected">What Analytics are Collected?</a></li>
<li><a href="#whats-the-difference-between-an-app-and-an-integration">What's the Difference Between an "App" and an "Integration"?</a></li>
</ul>
</li>
<li><a href="#command-line-tab-completion">Command Line Tab Completion</a></li>
<li><a href="#the-zapier-platform-packages">The Zapier Platform Packages</a><ul>
<li><a href="#updating-these-packages">Updating These Packages</a></li>
</ul>
</li>
<li><a href="#get-help">Get Help!</a></li>
<li><a href="#developing-on-the-cli">Developing on the CLI</a></li>
</ul>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h2 id="getting-started">Getting Started</h2>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>If you're new to Zapier Platform CLI, we strongly recommend you to walk through the <a href="https://platform.zapier.com/cli_tutorials/getting-started">Tutorial</a> for a more thorough introduction.</p>
</blockquote>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h3 id="what-is-an-app">What is an App?</h3>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Note: this document uses "app" while modern Zapier nomenclature refers instead to "integrations". In both cases, the phrase refers to your code that connects your API with Zapier.</p>
</blockquote><p>A CLI App is an implementation of your app's API. You build a Node.js application
that exports a single object (<a href="https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md#appschema">JSON Schema</a>) and upload it to Zapier.
Zapier introspects that definition to find out what your app is capable of and
what options to present end users in the Zap Editor.</p><p>For those not familiar with Zapier terminology, here is how concepts in the CLI map to the end user experience:</p><ul>
<li><a href="#authentication">Authentication</a>, (usually) which lets us know what credentials to ask users
for. This is used during the "Connect Accounts" section of the Zap Editor.</li>
<li><a href="#triggerssearchescreates">Triggers</a>, which read data <em>from</em> your API. These have their own section in the Zap Editor.</li>
<li><a href="#triggerssearchescreates">Creates</a>, which send data <em>to</em> your API to create new records. These are listed under "Actions" in the Zap Editor.</li>
<li><a href="#triggerssearchescreates">Searches</a>, which find specific records <em>in</em> your system. These are also listed under "Actions" in the Zap Editor.</li>
<li><a href="#resources">Resources</a>, which define an object type in your API (say a contact) and the operations available to perform on it. These are automatically extracted into Triggers, Searches, and Creates.</li>
</ul>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h3 id="how-does-zapier-platform-cli-work">How does Zapier Platform CLI Work?</h3>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<p>Zapier takes the App you upload and sends it over to Amazon Web Service's Lambda. We then make calls to execute the operations your App defines as we execute Zaps. Your App takes the input data we provide (if any), makes the necessary HTTP calls, and returns the relevant data, which gets fed back into Zapier.</p>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h3 id="zapier-platform-cli-vs-ui">Zapier Platform CLI vs UI</h3>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<p>The Zapier Platform includes two ways to build integrations: a CLI (to build integrations in your local development environment and deploy them from the command line), and a Visual Builder (to create integrations with a visual builder from your browser). Both use the same underlying platform, so pick the one that fits your team's needs best. The main difference is how you make changes to your code.</p><p>Zapier Platform CLI is designed to be used by development teams who collaborate with version control and CI, and can be used to build more advanced integrations with custom coding for every part of your API calls and response parsing.</p><p><a href="https://developer.zapier.com/">Zapier Platform UI</a> is designed to quickly spin up new integrations, and collaborate on them with teams that include non-developers. It's the quickest way to start using the Zapier platform—and you can manage your CLI apps' core details from its online UI as well. You can also <a href="https://platform.zapier.com/docs/export">export</a> Zapier Platform UI integrations to CLI to start development in your browser, then finish out the core features in your local development environment.</p><blockquote>
<p>Learn more in our <a href="https://platform.zapier.com/docs/vs">Zapier Platform UI vs CLI</a> post.</p>
</blockquote>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h3 id="requirements">Requirements</h3>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<p>All Zapier CLI apps are run using Node.js <code>v18</code>.</p><p>You can develop using any version of Node you'd like, but your eventual code must be compatible with <code>v18</code>. If you're using features not yet available in <code>v18</code>, you can transpile your code to a compatible format with <a href="https://babeljs.io/">Babel</a> (or similar).</p><p>To ensure stability for our users, we strongly encourage you run tests on <code>v18</code> sometime before your code reaches users. This can be done multiple ways.</p><p>Firstly, by using a CI tool (like <a href="https://travis-ci.org/">Travis CI</a> or <a href="https://circleci.com/">Circle CI</a>, which are free for open source projects). We provide a sample <a href="https://github.com/zapier/zapier-platform/blob/main/example-apps/trigger/.travis.yml">.travis.yml</a> file in our template apps to get you started.</p><p>Alternatively, you can change your local node version with tools such as <a href="https://github.com/nvm-sh/nvm#installation-and-update">nvm</a>. Then you can either swap to that version with <code>nvm use v18</code>, or do <code>nvm exec v18 zapier test</code> so you can run tests without having to switch versions while developing.</p>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h3 id="quick-setup-guide">Quick Setup Guide</h3>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<p>First up is installing the CLI and setting up your auth to create a working "Zapier Example" application. It will be private to you and visible in your live <a href="https://zapier.com/app/editor">Zap Editor</a>.</p>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash"><span class="hljs-comment"># install the CLI globally</span>
npm install -g zapier-platform-cli
<span class="hljs-comment"># setup auth to Zapier's platform with a deploy key</span>
zapier login
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Note: If you log into Zapier via the single sign-on (Google, Facebook, or Microsoft), you may not have a Zapier password. If that's the case, you'll need to generate a deploy key, go to <a href="https://developer.zapier.com/partner-settings/deploy-keys/">your Zapier developer account here</a> and create/copy a key, then run <code>zapier login</code> command with the --sso flag.</p>
</blockquote><p>Your Zapier CLI should be installed and ready to go at this point. Next up, we'll create our first app!</p>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash"><span class="hljs-comment"># create a directory with the minimum required files</span>
zapier init example-app
> Note: When you run `zapier init`, you<span class="hljs-string">'ll be presented with a list of templates to start with. Pick the one that matches a feature you'</span>ll need (such as <span class="hljs-string">"dynamic-dropdown"</span> <span class="hljs-keyword">for</span> an integration with [dynamic dropdown fields](https://github.com/zapier/zapier-platform/blob/main/packages/cli/README.md<span class="hljs-comment">#dynamic-dropdowns)), or select "minimal" for an integration with only the essentials. [View more example apps here](https://github.com/zapier/zapier-platform/tree/main/example-apps).</span>
<span class="hljs-comment"># move into the new directory</span>
<span class="hljs-built_in">cd</span> example-app
<span class="hljs-comment"># install all the libraries needed for your app</span>
npm install
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<p>Depending on the authentication method for your app, you'll also likely need to set your <code>CLIENT_ID</code> and <code>CLIENT_SECRET</code> as environment variables. These are the consumer key and secret in OAuth1 terminology.</p>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash"><span class="hljs-comment"># setting the environment variables on Zapier.com</span>
$ zapier env:<span class="hljs-built_in">set</span> 1.0.0 CLIENT_ID=1234
$ zapier env:<span class="hljs-built_in">set</span> 1.0.0 CLIENT_SECRET=abcd
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<p>You should now have a working local app. You can run several local commands to try it out.</p>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash"><span class="hljs-comment"># run the local tests</span>
<span class="hljs-comment"># the same as npm test, but adds some extra things to the environment</span>
zapier <span class="hljs-built_in">test</span>
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<p>Next, you'll probably want to upload app to Zapier itself so you can start testing live.</p>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash"><span class="hljs-comment"># push your app to Zapier</span>
zapier push
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Go check out our <a href="https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md#zapier-cli-reference">full CLI reference documentation</a> to see all the other commands!</p>
</blockquote>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h3 id="tutorial">Tutorial</h3>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<p>For a full tutorial, head over to our <a href="https://platform.zapier.com/cli_tutorials/getting-started">Tutorial</a> for a comprehensive walkthrough for creating your first app. If this isn't your first rodeo, read on!</p>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h2 id="creating-a-local-app">Creating a Local App</h2>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Tip: Check the <a href="https://github.com/zapier/zapier-platform/blob/main/packages/cli/README.md#quick-setup-guide">Quick Setup</a> if this is your first time using the platform!</p>
</blockquote><p>Creating an App can be done entirely locally and they are fairly simple Node.js apps using the standard Node environment and should be completely testable. However, a local app stays local until you <code>zapier register</code>.</p>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash"><span class="hljs-comment"># make your folder</span>
mkdir zapier-example
<span class="hljs-built_in">cd</span> zapier-example
<span class="hljs-comment"># create the needed files from a template</span>
zapier init . --template minimal
<span class="hljs-comment"># install all the libraries needed for your app</span>
npm install
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<p>If you'd like to manage your <strong>local App</strong>, use these commands:</p><ul>
<li><code>zapier init myapp</code> - initialize/start a local app project</li>
<li><code>zapier convert 1234 .</code> - initialize/start from an existing app</li>
<li><code>zapier scaffold resource Contact</code> - auto-injects a new resource, trigger, etc.</li>
<li><code>zapier test</code> - run the same tests as <code>npm test</code></li>
<li><code>zapier validate</code> - ensure your app is valid</li>
<li><code>zapier describe</code> - print some helpful information about your app</li>
</ul>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h3 id="local-project-structure">Local Project Structure</h3>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<p>In your app's folder, you should see this general recommended structure. The <code>index.js</code> is Zapier's entry point to your app. Zapier expects you to export an <code>App</code> definition there.</p>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code>$ tree .
.
├── README.md
├── index.js
├── package.json
├── triggers
│ └── contact-by-tag.js
├── resources
│ └── Contact.js
├── test
│ ├── basic.js
│ ├── triggers.js
│ └── resources.js
├── build
│ └── build.zip
└── node_modules
├── ...
└── ...
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h3 id="local-app-definition">Local App Definition</h3>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<p>The core definition of your <code>App</code> will look something like this, and is what your <code>index.js</code> should provide as the <em>only</em> export:</p>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-js"><span class="hljs-keyword">const</span> App = {
<span class="hljs-comment">// both version strings are required</span>
<span class="hljs-attr">version</span>: <span class="hljs-built_in">require</span>(<span class="hljs-string">'./package.json'</span>).version,
<span class="hljs-attr">platformVersion</span>: <span class="hljs-built_in">require</span>(<span class="hljs-string">'zapier-platform-core'</span>).version,
<span class="hljs-comment">// see "Authentication" section below</span>
<span class="hljs-attr">authentication</span>: {},
<span class="hljs-comment">// see "Dehydration" section below</span>
<span class="hljs-attr">hydrators</span>: {},
<span class="hljs-comment">// see "Making HTTP Requests" section below</span>
<span class="hljs-attr">requestTemplate</span>: {},
<span class="hljs-attr">beforeRequest</span>: [],
<span class="hljs-attr">afterResponse</span>: [],
<span class="hljs-comment">// See "Resources" section below</span>
<span class="hljs-attr">resources</span>: {},
<span class="hljs-comment">// See "Triggers/Searches/Creates" section below</span>
<span class="hljs-attr">triggers</span>: {},
<span class="hljs-attr">searches</span>: {},
<span class="hljs-attr">creates</span>: {},
};
<span class="hljs-built_in">module</span>.exports = App;
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Tip: You can use higher order functions to create any part of your App definition!</p>
</blockquote>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h2 id="registering-an-app">Registering an App</h2>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<p>Registering your App with Zapier is a necessary first step which only enables basic administrative functions. It should happen before <code>zapier push</code> which is to used to actually expose an App Version in the Zapier interface and editor.</p>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash"><span class="hljs-comment"># register your app</span>
zapier register <span class="hljs-string">"Zapier Example"</span>
<span class="hljs-comment"># list your apps</span>
zapier integrations
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Note: This doesn't put your app in the editor - see the docs on pushing an App Version to do that!</p>
</blockquote><p>If you'd like to manage your <strong>App</strong>, use these commands:</p><ul>
<li><code>zapier integrations</code> - list the apps in Zapier you can administer</li>
<li><code>zapier register "App Title"</code> - creates a new app in Zapier</li>
<li><code>zapier link</code> - lists and links a selected app in Zapier to your current folder</li>
<li><code>zapier history</code> - print the history of your app</li>
<li><code>zapier team:add user@example.com admin</code> - add an admin to help maintain/develop your app</li>
<li><code>zapier users:add user@example.com 1.0.0</code> - invite a user try your app version 1.0.0</li>
</ul>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">