@segment/analytics-browser-actions-friendbuy 1.104.0 → 1.105.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/metadata.json ADDED
@@ -0,0 +1,2054 @@
1
+ {
2
+ "slug": "actions-friendbuy",
3
+ "name": "Friendbuy (Actions)",
4
+ "mode": "device",
5
+ "authentication": {
6
+ "scheme": "custom",
7
+ "fields": {
8
+ "merchantId": {
9
+ "label": "Friendbuy Merchant ID",
10
+ "description": "Find your Friendbuy Merchant ID by logging in to your [Friendbuy account](https://retailer.friendbuy.io/) and going to Developer Center > Friendbuy Code.",
11
+ "type": "string",
12
+ "required": true,
13
+ "multiple": false,
14
+ "choices": null,
15
+ "default": null,
16
+ "depends_on": null
17
+ }
18
+ }
19
+ },
20
+ "audienceConfig": null,
21
+ "actions": {
22
+ "trackCustomer": {
23
+ "title": "Track Customer",
24
+ "description": "Create a new customer profile or update an existing customer profile.",
25
+ "platform": "web",
26
+ "defaultSubscription": "type = \"identify\"",
27
+ "hidden": false,
28
+ "hasPerformBatch": false,
29
+ "syncMode": null,
30
+ "hooks": null,
31
+ "dynamicFields": null,
32
+ "fields": {
33
+ "customerId": {
34
+ "label": "Customer ID",
35
+ "description": "The user's customer ID.",
36
+ "type": "string",
37
+ "required": true,
38
+ "multiple": false,
39
+ "allowNull": false,
40
+ "dynamic": false,
41
+ "default": {
42
+ "@path": "$.userId"
43
+ },
44
+ "choices": null,
45
+ "placeholder": null,
46
+ "properties": null,
47
+ "category": null,
48
+ "depends_on": null,
49
+ "readOnly": null,
50
+ "hidden": null,
51
+ "minimum": null,
52
+ "maximum": null,
53
+ "defaultObjectUI": null,
54
+ "disabledInputMethods": null,
55
+ "displayMode": null,
56
+ "format": null,
57
+ "additionalProperties": false
58
+ },
59
+ "anonymousId": {
60
+ "label": "Anonymous ID",
61
+ "description": "The user's anonymous id.",
62
+ "type": "string",
63
+ "required": false,
64
+ "multiple": false,
65
+ "allowNull": false,
66
+ "dynamic": false,
67
+ "default": {
68
+ "@path": "$.anonymousId"
69
+ },
70
+ "choices": null,
71
+ "placeholder": null,
72
+ "properties": null,
73
+ "category": null,
74
+ "depends_on": null,
75
+ "readOnly": null,
76
+ "hidden": null,
77
+ "minimum": null,
78
+ "maximum": null,
79
+ "defaultObjectUI": null,
80
+ "disabledInputMethods": null,
81
+ "displayMode": null,
82
+ "format": null,
83
+ "additionalProperties": false
84
+ },
85
+ "email": {
86
+ "label": "Email",
87
+ "description": "The user's email address.",
88
+ "type": "string",
89
+ "required": true,
90
+ "multiple": false,
91
+ "allowNull": false,
92
+ "dynamic": false,
93
+ "default": {
94
+ "@path": "$.traits.email"
95
+ },
96
+ "choices": null,
97
+ "placeholder": null,
98
+ "properties": null,
99
+ "category": null,
100
+ "depends_on": null,
101
+ "readOnly": null,
102
+ "hidden": null,
103
+ "minimum": null,
104
+ "maximum": null,
105
+ "defaultObjectUI": null,
106
+ "disabledInputMethods": null,
107
+ "displayMode": null,
108
+ "format": null,
109
+ "additionalProperties": false
110
+ },
111
+ "firstName": {
112
+ "label": "First Name",
113
+ "description": "The user's given name.",
114
+ "type": "string",
115
+ "required": false,
116
+ "multiple": false,
117
+ "allowNull": false,
118
+ "dynamic": false,
119
+ "default": {
120
+ "@path": "$.traits.firstName"
121
+ },
122
+ "choices": null,
123
+ "placeholder": null,
124
+ "properties": null,
125
+ "category": null,
126
+ "depends_on": null,
127
+ "readOnly": null,
128
+ "hidden": null,
129
+ "minimum": null,
130
+ "maximum": null,
131
+ "defaultObjectUI": null,
132
+ "disabledInputMethods": null,
133
+ "displayMode": null,
134
+ "format": null,
135
+ "additionalProperties": false
136
+ },
137
+ "lastName": {
138
+ "label": "Last Name",
139
+ "description": "The user's surname.",
140
+ "type": "string",
141
+ "required": false,
142
+ "multiple": false,
143
+ "allowNull": false,
144
+ "dynamic": false,
145
+ "default": {
146
+ "@path": "$.traits.lastName"
147
+ },
148
+ "choices": null,
149
+ "placeholder": null,
150
+ "properties": null,
151
+ "category": null,
152
+ "depends_on": null,
153
+ "readOnly": null,
154
+ "hidden": null,
155
+ "minimum": null,
156
+ "maximum": null,
157
+ "defaultObjectUI": null,
158
+ "disabledInputMethods": null,
159
+ "displayMode": null,
160
+ "format": null,
161
+ "additionalProperties": false
162
+ },
163
+ "name": {
164
+ "label": "Name",
165
+ "description": "The user's full name. If the name trait doesn't exist then it will be automatically derived from the firstName and lastName traits if they are defined.",
166
+ "type": "string",
167
+ "required": false,
168
+ "multiple": false,
169
+ "allowNull": false,
170
+ "dynamic": false,
171
+ "default": {
172
+ "@path": "$.traits.name"
173
+ },
174
+ "choices": null,
175
+ "placeholder": null,
176
+ "properties": null,
177
+ "category": null,
178
+ "depends_on": null,
179
+ "readOnly": null,
180
+ "hidden": null,
181
+ "minimum": null,
182
+ "maximum": null,
183
+ "defaultObjectUI": null,
184
+ "disabledInputMethods": null,
185
+ "displayMode": null,
186
+ "format": null,
187
+ "additionalProperties": false
188
+ },
189
+ "age": {
190
+ "label": "Age",
191
+ "description": "The user's age.",
192
+ "type": "number",
193
+ "required": false,
194
+ "multiple": false,
195
+ "allowNull": false,
196
+ "dynamic": false,
197
+ "default": {
198
+ "@path": "$.traits.age"
199
+ },
200
+ "choices": null,
201
+ "placeholder": null,
202
+ "properties": null,
203
+ "category": null,
204
+ "depends_on": null,
205
+ "readOnly": null,
206
+ "hidden": null,
207
+ "minimum": null,
208
+ "maximum": null,
209
+ "defaultObjectUI": null,
210
+ "disabledInputMethods": null,
211
+ "displayMode": null,
212
+ "format": null,
213
+ "additionalProperties": false
214
+ },
215
+ "birthday": {
216
+ "label": "Birthday",
217
+ "description": "The user's birthday in the format \"YYYY-MM-DD\", or \"0000-MM-DD\" to omit the year.",
218
+ "type": "string",
219
+ "required": false,
220
+ "multiple": false,
221
+ "allowNull": false,
222
+ "dynamic": false,
223
+ "default": {
224
+ "@path": "$.traits.birthday"
225
+ },
226
+ "choices": null,
227
+ "placeholder": null,
228
+ "properties": null,
229
+ "category": null,
230
+ "depends_on": null,
231
+ "readOnly": null,
232
+ "hidden": null,
233
+ "minimum": null,
234
+ "maximum": null,
235
+ "defaultObjectUI": null,
236
+ "disabledInputMethods": null,
237
+ "displayMode": null,
238
+ "format": "date",
239
+ "additionalProperties": false
240
+ },
241
+ "language": {
242
+ "label": "Language",
243
+ "description": "The user's language.",
244
+ "type": "string",
245
+ "required": false,
246
+ "multiple": false,
247
+ "allowNull": false,
248
+ "dynamic": false,
249
+ "default": {
250
+ "@path": "$.traits.language"
251
+ },
252
+ "choices": null,
253
+ "placeholder": null,
254
+ "properties": null,
255
+ "category": null,
256
+ "depends_on": null,
257
+ "readOnly": null,
258
+ "hidden": null,
259
+ "minimum": null,
260
+ "maximum": null,
261
+ "defaultObjectUI": null,
262
+ "disabledInputMethods": null,
263
+ "displayMode": null,
264
+ "format": null,
265
+ "additionalProperties": false
266
+ },
267
+ "addressCountry": {
268
+ "label": "Country",
269
+ "description": "The user's country.",
270
+ "type": "string",
271
+ "required": false,
272
+ "multiple": false,
273
+ "allowNull": false,
274
+ "dynamic": false,
275
+ "default": {
276
+ "@path": "$.traits.address.country"
277
+ },
278
+ "choices": null,
279
+ "placeholder": null,
280
+ "properties": null,
281
+ "category": null,
282
+ "depends_on": null,
283
+ "readOnly": null,
284
+ "hidden": null,
285
+ "minimum": null,
286
+ "maximum": null,
287
+ "defaultObjectUI": null,
288
+ "disabledInputMethods": null,
289
+ "displayMode": null,
290
+ "format": null,
291
+ "additionalProperties": false
292
+ },
293
+ "addressState": {
294
+ "label": "State",
295
+ "description": "The user's state.",
296
+ "type": "string",
297
+ "required": false,
298
+ "multiple": false,
299
+ "allowNull": false,
300
+ "dynamic": false,
301
+ "default": {
302
+ "@path": "$.traits.address.state"
303
+ },
304
+ "choices": null,
305
+ "placeholder": null,
306
+ "properties": null,
307
+ "category": null,
308
+ "depends_on": null,
309
+ "readOnly": null,
310
+ "hidden": null,
311
+ "minimum": null,
312
+ "maximum": null,
313
+ "defaultObjectUI": null,
314
+ "disabledInputMethods": null,
315
+ "displayMode": null,
316
+ "format": null,
317
+ "additionalProperties": false
318
+ },
319
+ "addressCity": {
320
+ "label": "City",
321
+ "description": "The user's city.",
322
+ "type": "string",
323
+ "required": false,
324
+ "multiple": false,
325
+ "allowNull": false,
326
+ "dynamic": false,
327
+ "default": {
328
+ "@path": "$.traits.address.city"
329
+ },
330
+ "choices": null,
331
+ "placeholder": null,
332
+ "properties": null,
333
+ "category": null,
334
+ "depends_on": null,
335
+ "readOnly": null,
336
+ "hidden": null,
337
+ "minimum": null,
338
+ "maximum": null,
339
+ "defaultObjectUI": null,
340
+ "disabledInputMethods": null,
341
+ "displayMode": null,
342
+ "format": null,
343
+ "additionalProperties": false
344
+ },
345
+ "addressPostalCode": {
346
+ "label": "State",
347
+ "description": "The user's postal code.",
348
+ "type": "string",
349
+ "required": false,
350
+ "multiple": false,
351
+ "allowNull": false,
352
+ "dynamic": false,
353
+ "default": {
354
+ "@path": "$.traits.address.postalCode"
355
+ },
356
+ "choices": null,
357
+ "placeholder": null,
358
+ "properties": null,
359
+ "category": null,
360
+ "depends_on": null,
361
+ "readOnly": null,
362
+ "hidden": null,
363
+ "minimum": null,
364
+ "maximum": null,
365
+ "defaultObjectUI": null,
366
+ "disabledInputMethods": null,
367
+ "displayMode": null,
368
+ "format": null,
369
+ "additionalProperties": false
370
+ },
371
+ "customerSince": {
372
+ "label": "Customer Since",
373
+ "description": "The date the user became a customer.",
374
+ "type": "string",
375
+ "required": false,
376
+ "multiple": false,
377
+ "allowNull": false,
378
+ "dynamic": false,
379
+ "default": {
380
+ "@path": "$.traits.customerSince"
381
+ },
382
+ "choices": null,
383
+ "placeholder": null,
384
+ "properties": null,
385
+ "category": null,
386
+ "depends_on": null,
387
+ "readOnly": null,
388
+ "hidden": null,
389
+ "minimum": null,
390
+ "maximum": null,
391
+ "defaultObjectUI": null,
392
+ "disabledInputMethods": null,
393
+ "displayMode": null,
394
+ "format": "date-time",
395
+ "additionalProperties": false
396
+ },
397
+ "loyaltyStatus": {
398
+ "label": "Loyalty Status",
399
+ "description": "The status of the user in your loyalty program. Valid values are \"in\", \"out\", or \"blocked\".",
400
+ "type": "string",
401
+ "required": false,
402
+ "multiple": false,
403
+ "allowNull": false,
404
+ "dynamic": false,
405
+ "default": {
406
+ "@path": "$.traits.loyaltyStatus"
407
+ },
408
+ "choices": null,
409
+ "placeholder": null,
410
+ "properties": null,
411
+ "category": null,
412
+ "depends_on": null,
413
+ "readOnly": null,
414
+ "hidden": null,
415
+ "minimum": null,
416
+ "maximum": null,
417
+ "defaultObjectUI": null,
418
+ "disabledInputMethods": null,
419
+ "displayMode": null,
420
+ "format": null,
421
+ "additionalProperties": false
422
+ },
423
+ "isNewCustomer": {
424
+ "label": "New Customer Flag",
425
+ "description": "Flag to indicate whether the user is a new customer.",
426
+ "type": "boolean",
427
+ "required": false,
428
+ "multiple": false,
429
+ "allowNull": false,
430
+ "dynamic": false,
431
+ "default": {
432
+ "@path": "$.traits.isNewCustomer"
433
+ },
434
+ "choices": null,
435
+ "placeholder": null,
436
+ "properties": null,
437
+ "category": null,
438
+ "depends_on": null,
439
+ "readOnly": null,
440
+ "hidden": null,
441
+ "minimum": null,
442
+ "maximum": null,
443
+ "defaultObjectUI": null,
444
+ "disabledInputMethods": null,
445
+ "displayMode": null,
446
+ "format": null,
447
+ "additionalProperties": false
448
+ },
449
+ "friendbuyAttributes": {
450
+ "label": "Custom Attributes",
451
+ "description": "Custom attributes to send to Friendbuy. You should pass an object whose keys are the names of the custom attributes and whose values are strings. Non-string-valued attributes will be dropped.",
452
+ "type": "object",
453
+ "required": false,
454
+ "multiple": false,
455
+ "allowNull": false,
456
+ "dynamic": false,
457
+ "default": {
458
+ "@path": "$.traits.friendbuyAttributes"
459
+ },
460
+ "choices": null,
461
+ "placeholder": null,
462
+ "properties": null,
463
+ "category": null,
464
+ "depends_on": null,
465
+ "readOnly": null,
466
+ "hidden": null,
467
+ "minimum": null,
468
+ "maximum": null,
469
+ "defaultObjectUI": null,
470
+ "disabledInputMethods": null,
471
+ "displayMode": null,
472
+ "format": null,
473
+ "additionalProperties": false
474
+ }
475
+ }
476
+ },
477
+ "trackPurchase": {
478
+ "title": "Track Purchase",
479
+ "description": "Record when a customer makes a purchase.",
480
+ "platform": "web",
481
+ "defaultSubscription": "event = \"Order Completed\"",
482
+ "hidden": false,
483
+ "hasPerformBatch": false,
484
+ "syncMode": null,
485
+ "hooks": null,
486
+ "dynamicFields": null,
487
+ "fields": {
488
+ "orderId": {
489
+ "label": "Order ID",
490
+ "description": "The order ID.",
491
+ "type": "string",
492
+ "required": true,
493
+ "multiple": false,
494
+ "allowNull": false,
495
+ "dynamic": false,
496
+ "default": {
497
+ "@path": "$.properties.order_id"
498
+ },
499
+ "choices": null,
500
+ "placeholder": null,
501
+ "properties": null,
502
+ "category": null,
503
+ "depends_on": null,
504
+ "readOnly": null,
505
+ "hidden": null,
506
+ "minimum": null,
507
+ "maximum": null,
508
+ "defaultObjectUI": null,
509
+ "disabledInputMethods": null,
510
+ "displayMode": null,
511
+ "format": null,
512
+ "additionalProperties": false
513
+ },
514
+ "amount": {
515
+ "label": "Purchase Amount",
516
+ "description": "Purchase amount to be considered when evaluating reward rules.",
517
+ "type": "number",
518
+ "required": true,
519
+ "multiple": false,
520
+ "allowNull": false,
521
+ "dynamic": false,
522
+ "default": {
523
+ "@path": "$.properties.total"
524
+ },
525
+ "choices": null,
526
+ "placeholder": null,
527
+ "properties": null,
528
+ "category": null,
529
+ "depends_on": null,
530
+ "readOnly": null,
531
+ "hidden": null,
532
+ "minimum": null,
533
+ "maximum": null,
534
+ "defaultObjectUI": null,
535
+ "disabledInputMethods": null,
536
+ "displayMode": null,
537
+ "format": null,
538
+ "additionalProperties": false
539
+ },
540
+ "currency": {
541
+ "label": "Currency",
542
+ "description": "The currency of the purchase amount.",
543
+ "type": "string",
544
+ "required": true,
545
+ "multiple": false,
546
+ "allowNull": false,
547
+ "dynamic": false,
548
+ "default": {
549
+ "@path": "$.properties.currency"
550
+ },
551
+ "choices": null,
552
+ "placeholder": null,
553
+ "properties": null,
554
+ "category": null,
555
+ "depends_on": null,
556
+ "readOnly": null,
557
+ "hidden": null,
558
+ "minimum": null,
559
+ "maximum": null,
560
+ "defaultObjectUI": null,
561
+ "disabledInputMethods": null,
562
+ "displayMode": null,
563
+ "format": null,
564
+ "additionalProperties": false
565
+ },
566
+ "coupon": {
567
+ "label": "Coupon",
568
+ "description": "The coupon code of any coupon redeemed with the order.",
569
+ "type": "string",
570
+ "required": false,
571
+ "multiple": false,
572
+ "allowNull": false,
573
+ "dynamic": false,
574
+ "default": {
575
+ "@path": "$.properties.coupon"
576
+ },
577
+ "choices": null,
578
+ "placeholder": null,
579
+ "properties": null,
580
+ "category": null,
581
+ "depends_on": null,
582
+ "readOnly": null,
583
+ "hidden": null,
584
+ "minimum": null,
585
+ "maximum": null,
586
+ "defaultObjectUI": null,
587
+ "disabledInputMethods": null,
588
+ "displayMode": null,
589
+ "format": null,
590
+ "additionalProperties": false
591
+ },
592
+ "attributionId": {
593
+ "label": "Friendbuy Attribution ID",
594
+ "description": "Friendbuy attribution ID that associates the purchase with the advocate who referred the purchaser.",
595
+ "type": "string",
596
+ "required": false,
597
+ "multiple": false,
598
+ "allowNull": false,
599
+ "dynamic": false,
600
+ "default": {
601
+ "@path": "$.properties.attributionId"
602
+ },
603
+ "choices": null,
604
+ "placeholder": null,
605
+ "properties": null,
606
+ "category": null,
607
+ "depends_on": null,
608
+ "readOnly": null,
609
+ "hidden": null,
610
+ "minimum": null,
611
+ "maximum": null,
612
+ "defaultObjectUI": null,
613
+ "disabledInputMethods": null,
614
+ "displayMode": null,
615
+ "format": null,
616
+ "additionalProperties": false
617
+ },
618
+ "referralCode": {
619
+ "label": "Friendbuy Referral ID",
620
+ "description": "Friendbuy referral code that associates the purchase with the advocate who referred the purchaser.",
621
+ "type": "string",
622
+ "required": false,
623
+ "multiple": false,
624
+ "allowNull": false,
625
+ "dynamic": false,
626
+ "default": {
627
+ "@path": "$.properties.referralCode"
628
+ },
629
+ "choices": null,
630
+ "placeholder": null,
631
+ "properties": null,
632
+ "category": null,
633
+ "depends_on": null,
634
+ "readOnly": null,
635
+ "hidden": null,
636
+ "minimum": null,
637
+ "maximum": null,
638
+ "defaultObjectUI": null,
639
+ "disabledInputMethods": null,
640
+ "displayMode": null,
641
+ "format": null,
642
+ "additionalProperties": false
643
+ },
644
+ "giftCardCodes": {
645
+ "label": "Gift Card Codes",
646
+ "description": "An array of gift card codes applied to the order.",
647
+ "type": "string",
648
+ "required": false,
649
+ "multiple": true,
650
+ "allowNull": false,
651
+ "dynamic": false,
652
+ "default": {
653
+ "@path": "$.properties.giftCardCodes"
654
+ },
655
+ "choices": null,
656
+ "placeholder": null,
657
+ "properties": null,
658
+ "category": null,
659
+ "depends_on": null,
660
+ "readOnly": null,
661
+ "hidden": null,
662
+ "minimum": null,
663
+ "maximum": null,
664
+ "defaultObjectUI": null,
665
+ "disabledInputMethods": null,
666
+ "displayMode": null,
667
+ "format": null,
668
+ "additionalProperties": false
669
+ },
670
+ "products": {
671
+ "label": "Products",
672
+ "description": "Products purchased.",
673
+ "type": "object",
674
+ "required": false,
675
+ "multiple": true,
676
+ "allowNull": false,
677
+ "dynamic": false,
678
+ "default": {
679
+ "@path": "$.properties.products"
680
+ },
681
+ "choices": null,
682
+ "placeholder": null,
683
+ "properties": {
684
+ "sku": {
685
+ "label": "Product SKU",
686
+ "type": "string",
687
+ "required": false,
688
+ "multiple": false,
689
+ "allowNull": false,
690
+ "dynamic": false,
691
+ "default": null,
692
+ "choices": null,
693
+ "placeholder": null,
694
+ "properties": null,
695
+ "category": null,
696
+ "depends_on": null,
697
+ "readOnly": null,
698
+ "hidden": null,
699
+ "minimum": null,
700
+ "maximum": null,
701
+ "defaultObjectUI": null,
702
+ "disabledInputMethods": null,
703
+ "displayMode": null,
704
+ "format": null,
705
+ "additionalProperties": false
706
+ },
707
+ "name": {
708
+ "label": "Product Name",
709
+ "type": "string",
710
+ "required": false,
711
+ "multiple": false,
712
+ "allowNull": false,
713
+ "dynamic": false,
714
+ "default": null,
715
+ "choices": null,
716
+ "placeholder": null,
717
+ "properties": null,
718
+ "category": null,
719
+ "depends_on": null,
720
+ "readOnly": null,
721
+ "hidden": null,
722
+ "minimum": null,
723
+ "maximum": null,
724
+ "defaultObjectUI": null,
725
+ "disabledInputMethods": null,
726
+ "displayMode": null,
727
+ "format": null,
728
+ "additionalProperties": false
729
+ },
730
+ "quantity": {
731
+ "label": "Quantity (default 1)",
732
+ "type": "integer",
733
+ "required": false,
734
+ "multiple": false,
735
+ "allowNull": false,
736
+ "dynamic": false,
737
+ "default": null,
738
+ "choices": null,
739
+ "placeholder": null,
740
+ "properties": null,
741
+ "category": null,
742
+ "depends_on": null,
743
+ "readOnly": null,
744
+ "hidden": null,
745
+ "minimum": null,
746
+ "maximum": null,
747
+ "defaultObjectUI": null,
748
+ "disabledInputMethods": null,
749
+ "displayMode": null,
750
+ "format": null,
751
+ "additionalProperties": false
752
+ },
753
+ "price": {
754
+ "label": "Price",
755
+ "type": "number",
756
+ "required": true,
757
+ "multiple": false,
758
+ "allowNull": false,
759
+ "dynamic": false,
760
+ "default": null,
761
+ "choices": null,
762
+ "placeholder": null,
763
+ "properties": null,
764
+ "category": null,
765
+ "depends_on": null,
766
+ "readOnly": null,
767
+ "hidden": null,
768
+ "minimum": null,
769
+ "maximum": null,
770
+ "defaultObjectUI": null,
771
+ "disabledInputMethods": null,
772
+ "displayMode": null,
773
+ "format": null,
774
+ "additionalProperties": false
775
+ },
776
+ "description": {
777
+ "label": "Product Description",
778
+ "type": "string",
779
+ "required": false,
780
+ "multiple": false,
781
+ "allowNull": false,
782
+ "dynamic": false,
783
+ "default": null,
784
+ "choices": null,
785
+ "placeholder": null,
786
+ "properties": null,
787
+ "category": null,
788
+ "depends_on": null,
789
+ "readOnly": null,
790
+ "hidden": null,
791
+ "minimum": null,
792
+ "maximum": null,
793
+ "defaultObjectUI": null,
794
+ "disabledInputMethods": null,
795
+ "displayMode": null,
796
+ "format": null,
797
+ "additionalProperties": false
798
+ },
799
+ "category": {
800
+ "label": "Product Category",
801
+ "type": "string",
802
+ "required": false,
803
+ "multiple": false,
804
+ "allowNull": false,
805
+ "dynamic": false,
806
+ "default": null,
807
+ "choices": null,
808
+ "placeholder": null,
809
+ "properties": null,
810
+ "category": null,
811
+ "depends_on": null,
812
+ "readOnly": null,
813
+ "hidden": null,
814
+ "minimum": null,
815
+ "maximum": null,
816
+ "defaultObjectUI": null,
817
+ "disabledInputMethods": null,
818
+ "displayMode": null,
819
+ "format": null,
820
+ "additionalProperties": false
821
+ },
822
+ "url": {
823
+ "label": "Product URL",
824
+ "type": "string",
825
+ "required": false,
826
+ "multiple": false,
827
+ "allowNull": false,
828
+ "dynamic": false,
829
+ "default": null,
830
+ "choices": null,
831
+ "placeholder": null,
832
+ "properties": null,
833
+ "category": null,
834
+ "depends_on": null,
835
+ "readOnly": null,
836
+ "hidden": null,
837
+ "minimum": null,
838
+ "maximum": null,
839
+ "defaultObjectUI": null,
840
+ "disabledInputMethods": null,
841
+ "displayMode": null,
842
+ "format": null,
843
+ "additionalProperties": false
844
+ },
845
+ "image_url": {
846
+ "label": "Product Image URL",
847
+ "type": "string",
848
+ "required": false,
849
+ "multiple": false,
850
+ "allowNull": false,
851
+ "dynamic": false,
852
+ "default": null,
853
+ "choices": null,
854
+ "placeholder": null,
855
+ "properties": null,
856
+ "category": null,
857
+ "depends_on": null,
858
+ "readOnly": null,
859
+ "hidden": null,
860
+ "minimum": null,
861
+ "maximum": null,
862
+ "defaultObjectUI": null,
863
+ "disabledInputMethods": null,
864
+ "displayMode": null,
865
+ "format": null,
866
+ "additionalProperties": false
867
+ }
868
+ },
869
+ "category": null,
870
+ "depends_on": null,
871
+ "readOnly": null,
872
+ "hidden": null,
873
+ "minimum": null,
874
+ "maximum": null,
875
+ "defaultObjectUI": null,
876
+ "disabledInputMethods": null,
877
+ "displayMode": null,
878
+ "format": null,
879
+ "additionalProperties": false
880
+ },
881
+ "customerId": {
882
+ "label": "Customer ID",
883
+ "description": "The user's customer ID.",
884
+ "type": "string",
885
+ "required": false,
886
+ "multiple": false,
887
+ "allowNull": false,
888
+ "dynamic": false,
889
+ "default": {
890
+ "@if": {
891
+ "exists": {
892
+ "@path": "$.properties.customerId"
893
+ },
894
+ "then": {
895
+ "@path": "$.properties.customerId"
896
+ },
897
+ "else": {
898
+ "@path": "$.userId"
899
+ }
900
+ }
901
+ },
902
+ "choices": null,
903
+ "placeholder": null,
904
+ "properties": null,
905
+ "category": null,
906
+ "depends_on": null,
907
+ "readOnly": null,
908
+ "hidden": null,
909
+ "minimum": null,
910
+ "maximum": null,
911
+ "defaultObjectUI": null,
912
+ "disabledInputMethods": null,
913
+ "displayMode": null,
914
+ "format": null,
915
+ "additionalProperties": false
916
+ },
917
+ "anonymousId": {
918
+ "label": "Anonymous ID",
919
+ "description": "The user's anonymous ID.",
920
+ "type": "string",
921
+ "required": false,
922
+ "multiple": false,
923
+ "allowNull": false,
924
+ "dynamic": false,
925
+ "default": {
926
+ "@path": "$.anonymousId"
927
+ },
928
+ "choices": null,
929
+ "placeholder": null,
930
+ "properties": null,
931
+ "category": null,
932
+ "depends_on": null,
933
+ "readOnly": null,
934
+ "hidden": null,
935
+ "minimum": null,
936
+ "maximum": null,
937
+ "defaultObjectUI": null,
938
+ "disabledInputMethods": null,
939
+ "displayMode": null,
940
+ "format": null,
941
+ "additionalProperties": false
942
+ },
943
+ "email": {
944
+ "label": "Email",
945
+ "description": "The user's email address.",
946
+ "type": "string",
947
+ "required": false,
948
+ "multiple": false,
949
+ "allowNull": false,
950
+ "dynamic": false,
951
+ "default": {
952
+ "@path": "$.properties.email"
953
+ },
954
+ "choices": null,
955
+ "placeholder": null,
956
+ "properties": null,
957
+ "category": null,
958
+ "depends_on": null,
959
+ "readOnly": null,
960
+ "hidden": null,
961
+ "minimum": null,
962
+ "maximum": null,
963
+ "defaultObjectUI": null,
964
+ "disabledInputMethods": null,
965
+ "displayMode": null,
966
+ "format": null,
967
+ "additionalProperties": false
968
+ },
969
+ "isNewCustomer": {
970
+ "label": "New Customer Flag",
971
+ "description": "Flag to indicate whether the user is a new customer.",
972
+ "type": "boolean",
973
+ "required": false,
974
+ "multiple": false,
975
+ "allowNull": false,
976
+ "dynamic": false,
977
+ "default": {
978
+ "@path": "$.properties.isNewCustomer"
979
+ },
980
+ "choices": null,
981
+ "placeholder": null,
982
+ "properties": null,
983
+ "category": null,
984
+ "depends_on": null,
985
+ "readOnly": null,
986
+ "hidden": null,
987
+ "minimum": null,
988
+ "maximum": null,
989
+ "defaultObjectUI": null,
990
+ "disabledInputMethods": null,
991
+ "displayMode": null,
992
+ "format": null,
993
+ "additionalProperties": false
994
+ },
995
+ "loyaltyStatus": {
996
+ "label": "Loyalty Program Status",
997
+ "description": "The status of the user in your loyalty program. Valid values are \"in\", \"out\", or \"blocked\".",
998
+ "type": "string",
999
+ "required": false,
1000
+ "multiple": false,
1001
+ "allowNull": false,
1002
+ "dynamic": false,
1003
+ "default": {
1004
+ "@path": "$.properties.loyaltyStatus"
1005
+ },
1006
+ "choices": null,
1007
+ "placeholder": null,
1008
+ "properties": null,
1009
+ "category": null,
1010
+ "depends_on": null,
1011
+ "readOnly": null,
1012
+ "hidden": null,
1013
+ "minimum": null,
1014
+ "maximum": null,
1015
+ "defaultObjectUI": null,
1016
+ "disabledInputMethods": null,
1017
+ "displayMode": null,
1018
+ "format": null,
1019
+ "additionalProperties": false
1020
+ },
1021
+ "firstName": {
1022
+ "label": "First Name",
1023
+ "description": "The user's given name.",
1024
+ "type": "string",
1025
+ "required": false,
1026
+ "multiple": false,
1027
+ "allowNull": false,
1028
+ "dynamic": false,
1029
+ "default": {
1030
+ "@path": "$.properties.firstName"
1031
+ },
1032
+ "choices": null,
1033
+ "placeholder": null,
1034
+ "properties": null,
1035
+ "category": null,
1036
+ "depends_on": null,
1037
+ "readOnly": null,
1038
+ "hidden": null,
1039
+ "minimum": null,
1040
+ "maximum": null,
1041
+ "defaultObjectUI": null,
1042
+ "disabledInputMethods": null,
1043
+ "displayMode": null,
1044
+ "format": null,
1045
+ "additionalProperties": false
1046
+ },
1047
+ "lastName": {
1048
+ "label": "Last Name",
1049
+ "description": "The user's surname.",
1050
+ "type": "string",
1051
+ "required": false,
1052
+ "multiple": false,
1053
+ "allowNull": false,
1054
+ "dynamic": false,
1055
+ "default": {
1056
+ "@path": "$.properties.lastName"
1057
+ },
1058
+ "choices": null,
1059
+ "placeholder": null,
1060
+ "properties": null,
1061
+ "category": null,
1062
+ "depends_on": null,
1063
+ "readOnly": null,
1064
+ "hidden": null,
1065
+ "minimum": null,
1066
+ "maximum": null,
1067
+ "defaultObjectUI": null,
1068
+ "disabledInputMethods": null,
1069
+ "displayMode": null,
1070
+ "format": null,
1071
+ "additionalProperties": false
1072
+ },
1073
+ "name": {
1074
+ "label": "Name",
1075
+ "description": "The user's full name.",
1076
+ "type": "string",
1077
+ "required": false,
1078
+ "multiple": false,
1079
+ "allowNull": false,
1080
+ "dynamic": false,
1081
+ "default": {
1082
+ "@path": "$.properties.name"
1083
+ },
1084
+ "choices": null,
1085
+ "placeholder": null,
1086
+ "properties": null,
1087
+ "category": null,
1088
+ "depends_on": null,
1089
+ "readOnly": null,
1090
+ "hidden": null,
1091
+ "minimum": null,
1092
+ "maximum": null,
1093
+ "defaultObjectUI": null,
1094
+ "disabledInputMethods": null,
1095
+ "displayMode": null,
1096
+ "format": null,
1097
+ "additionalProperties": false
1098
+ },
1099
+ "age": {
1100
+ "label": "Age",
1101
+ "description": "The user's age.",
1102
+ "type": "number",
1103
+ "required": false,
1104
+ "multiple": false,
1105
+ "allowNull": false,
1106
+ "dynamic": false,
1107
+ "default": {
1108
+ "@path": "$.properties.age"
1109
+ },
1110
+ "choices": null,
1111
+ "placeholder": null,
1112
+ "properties": null,
1113
+ "category": null,
1114
+ "depends_on": null,
1115
+ "readOnly": null,
1116
+ "hidden": null,
1117
+ "minimum": null,
1118
+ "maximum": null,
1119
+ "defaultObjectUI": null,
1120
+ "disabledInputMethods": null,
1121
+ "displayMode": null,
1122
+ "format": null,
1123
+ "additionalProperties": false
1124
+ },
1125
+ "birthday": {
1126
+ "label": "Birthday",
1127
+ "description": "The user's birthday in the format \"YYYY-MM-DD\", or \"0000-MM-DD\" to omit the year.",
1128
+ "type": "string",
1129
+ "required": false,
1130
+ "multiple": false,
1131
+ "allowNull": false,
1132
+ "dynamic": false,
1133
+ "default": {
1134
+ "@path": "$.properties.birthday"
1135
+ },
1136
+ "choices": null,
1137
+ "placeholder": null,
1138
+ "properties": null,
1139
+ "category": null,
1140
+ "depends_on": null,
1141
+ "readOnly": null,
1142
+ "hidden": null,
1143
+ "minimum": null,
1144
+ "maximum": null,
1145
+ "defaultObjectUI": null,
1146
+ "disabledInputMethods": null,
1147
+ "displayMode": null,
1148
+ "format": "date",
1149
+ "additionalProperties": false
1150
+ },
1151
+ "friendbuyAttributes": {
1152
+ "label": "Custom Attributes",
1153
+ "description": "Custom attributes to send to Friendbuy. You should pass an object whose keys are the names of the custom attributes and whose values are strings. Non-string-valued attributes will be dropped.",
1154
+ "type": "object",
1155
+ "required": false,
1156
+ "multiple": false,
1157
+ "allowNull": false,
1158
+ "dynamic": false,
1159
+ "default": {
1160
+ "@path": "$.properties.friendbuyAttributes"
1161
+ },
1162
+ "choices": null,
1163
+ "placeholder": null,
1164
+ "properties": null,
1165
+ "category": null,
1166
+ "depends_on": null,
1167
+ "readOnly": null,
1168
+ "hidden": null,
1169
+ "minimum": null,
1170
+ "maximum": null,
1171
+ "defaultObjectUI": null,
1172
+ "disabledInputMethods": null,
1173
+ "displayMode": null,
1174
+ "format": null,
1175
+ "additionalProperties": false
1176
+ }
1177
+ }
1178
+ },
1179
+ "trackSignUp": {
1180
+ "title": "Track Sign Up",
1181
+ "description": "Record when a customer signs up for a service.",
1182
+ "platform": "web",
1183
+ "defaultSubscription": "event = \"Signed Up\"",
1184
+ "hidden": false,
1185
+ "hasPerformBatch": false,
1186
+ "syncMode": null,
1187
+ "hooks": null,
1188
+ "dynamicFields": null,
1189
+ "fields": {
1190
+ "customerId": {
1191
+ "label": "Customer ID",
1192
+ "description": "The user's customer ID.",
1193
+ "type": "string",
1194
+ "required": true,
1195
+ "multiple": false,
1196
+ "allowNull": false,
1197
+ "dynamic": false,
1198
+ "default": {
1199
+ "@if": {
1200
+ "exists": {
1201
+ "@path": "$.properties.customerId"
1202
+ },
1203
+ "then": {
1204
+ "@path": "$.properties.customerId"
1205
+ },
1206
+ "else": {
1207
+ "@path": "$.userId"
1208
+ }
1209
+ }
1210
+ },
1211
+ "choices": null,
1212
+ "placeholder": null,
1213
+ "properties": null,
1214
+ "category": null,
1215
+ "depends_on": null,
1216
+ "readOnly": null,
1217
+ "hidden": null,
1218
+ "minimum": null,
1219
+ "maximum": null,
1220
+ "defaultObjectUI": null,
1221
+ "disabledInputMethods": null,
1222
+ "displayMode": null,
1223
+ "format": null,
1224
+ "additionalProperties": false
1225
+ },
1226
+ "anonymousId": {
1227
+ "label": "Anonymous ID",
1228
+ "description": "The user's anonymous ID.",
1229
+ "type": "string",
1230
+ "required": false,
1231
+ "multiple": false,
1232
+ "allowNull": false,
1233
+ "dynamic": false,
1234
+ "default": {
1235
+ "@path": "$.anonymousId"
1236
+ },
1237
+ "choices": null,
1238
+ "placeholder": null,
1239
+ "properties": null,
1240
+ "category": null,
1241
+ "depends_on": null,
1242
+ "readOnly": null,
1243
+ "hidden": null,
1244
+ "minimum": null,
1245
+ "maximum": null,
1246
+ "defaultObjectUI": null,
1247
+ "disabledInputMethods": null,
1248
+ "displayMode": null,
1249
+ "format": null,
1250
+ "additionalProperties": false
1251
+ },
1252
+ "email": {
1253
+ "label": "Email",
1254
+ "description": "The user's email address.",
1255
+ "type": "string",
1256
+ "required": true,
1257
+ "multiple": false,
1258
+ "allowNull": false,
1259
+ "dynamic": false,
1260
+ "default": {
1261
+ "@path": "$.properties.email"
1262
+ },
1263
+ "choices": null,
1264
+ "placeholder": null,
1265
+ "properties": null,
1266
+ "category": null,
1267
+ "depends_on": null,
1268
+ "readOnly": null,
1269
+ "hidden": null,
1270
+ "minimum": null,
1271
+ "maximum": null,
1272
+ "defaultObjectUI": null,
1273
+ "disabledInputMethods": null,
1274
+ "displayMode": null,
1275
+ "format": null,
1276
+ "additionalProperties": false
1277
+ },
1278
+ "isNewCustomer": {
1279
+ "label": "New Customer Flag",
1280
+ "description": "Flag to indicate whether the user is a new customer.",
1281
+ "type": "boolean",
1282
+ "required": false,
1283
+ "multiple": false,
1284
+ "allowNull": false,
1285
+ "dynamic": false,
1286
+ "default": {
1287
+ "@path": "$.properties.isNewCustomer"
1288
+ },
1289
+ "choices": null,
1290
+ "placeholder": null,
1291
+ "properties": null,
1292
+ "category": null,
1293
+ "depends_on": null,
1294
+ "readOnly": null,
1295
+ "hidden": null,
1296
+ "minimum": null,
1297
+ "maximum": null,
1298
+ "defaultObjectUI": null,
1299
+ "disabledInputMethods": null,
1300
+ "displayMode": null,
1301
+ "format": null,
1302
+ "additionalProperties": false
1303
+ },
1304
+ "loyaltyStatus": {
1305
+ "label": "Loyalty Program Status",
1306
+ "description": "The status of the user in your loyalty program. Valid values are \"in\", \"out\", or \"blocked\".",
1307
+ "type": "string",
1308
+ "required": false,
1309
+ "multiple": false,
1310
+ "allowNull": false,
1311
+ "dynamic": false,
1312
+ "default": {
1313
+ "@path": "$.properties.loyaltyStatus"
1314
+ },
1315
+ "choices": null,
1316
+ "placeholder": null,
1317
+ "properties": null,
1318
+ "category": null,
1319
+ "depends_on": null,
1320
+ "readOnly": null,
1321
+ "hidden": null,
1322
+ "minimum": null,
1323
+ "maximum": null,
1324
+ "defaultObjectUI": null,
1325
+ "disabledInputMethods": null,
1326
+ "displayMode": null,
1327
+ "format": null,
1328
+ "additionalProperties": false
1329
+ },
1330
+ "firstName": {
1331
+ "label": "First Name",
1332
+ "description": "The user's given name.",
1333
+ "type": "string",
1334
+ "required": false,
1335
+ "multiple": false,
1336
+ "allowNull": false,
1337
+ "dynamic": false,
1338
+ "default": {
1339
+ "@path": "$.properties.firstName"
1340
+ },
1341
+ "choices": null,
1342
+ "placeholder": null,
1343
+ "properties": null,
1344
+ "category": null,
1345
+ "depends_on": null,
1346
+ "readOnly": null,
1347
+ "hidden": null,
1348
+ "minimum": null,
1349
+ "maximum": null,
1350
+ "defaultObjectUI": null,
1351
+ "disabledInputMethods": null,
1352
+ "displayMode": null,
1353
+ "format": null,
1354
+ "additionalProperties": false
1355
+ },
1356
+ "lastName": {
1357
+ "label": "Last Name",
1358
+ "description": "The user's surname.",
1359
+ "type": "string",
1360
+ "required": false,
1361
+ "multiple": false,
1362
+ "allowNull": false,
1363
+ "dynamic": false,
1364
+ "default": {
1365
+ "@path": "$.properties.lastName"
1366
+ },
1367
+ "choices": null,
1368
+ "placeholder": null,
1369
+ "properties": null,
1370
+ "category": null,
1371
+ "depends_on": null,
1372
+ "readOnly": null,
1373
+ "hidden": null,
1374
+ "minimum": null,
1375
+ "maximum": null,
1376
+ "defaultObjectUI": null,
1377
+ "disabledInputMethods": null,
1378
+ "displayMode": null,
1379
+ "format": null,
1380
+ "additionalProperties": false
1381
+ },
1382
+ "name": {
1383
+ "label": "Name",
1384
+ "description": "The user's full name.",
1385
+ "type": "string",
1386
+ "required": false,
1387
+ "multiple": false,
1388
+ "allowNull": false,
1389
+ "dynamic": false,
1390
+ "default": {
1391
+ "@path": "$.properties.name"
1392
+ },
1393
+ "choices": null,
1394
+ "placeholder": null,
1395
+ "properties": null,
1396
+ "category": null,
1397
+ "depends_on": null,
1398
+ "readOnly": null,
1399
+ "hidden": null,
1400
+ "minimum": null,
1401
+ "maximum": null,
1402
+ "defaultObjectUI": null,
1403
+ "disabledInputMethods": null,
1404
+ "displayMode": null,
1405
+ "format": null,
1406
+ "additionalProperties": false
1407
+ },
1408
+ "age": {
1409
+ "label": "Age",
1410
+ "description": "The user's age.",
1411
+ "type": "number",
1412
+ "required": false,
1413
+ "multiple": false,
1414
+ "allowNull": false,
1415
+ "dynamic": false,
1416
+ "default": {
1417
+ "@path": "$.properties.age"
1418
+ },
1419
+ "choices": null,
1420
+ "placeholder": null,
1421
+ "properties": null,
1422
+ "category": null,
1423
+ "depends_on": null,
1424
+ "readOnly": null,
1425
+ "hidden": null,
1426
+ "minimum": null,
1427
+ "maximum": null,
1428
+ "defaultObjectUI": null,
1429
+ "disabledInputMethods": null,
1430
+ "displayMode": null,
1431
+ "format": null,
1432
+ "additionalProperties": false
1433
+ },
1434
+ "birthday": {
1435
+ "label": "Birthday",
1436
+ "description": "The user's birthday in the format \"YYYY-MM-DD\", or \"0000-MM-DD\" to omit the year.",
1437
+ "type": "string",
1438
+ "required": false,
1439
+ "multiple": false,
1440
+ "allowNull": false,
1441
+ "dynamic": false,
1442
+ "default": {
1443
+ "@path": "$.properties.birthday"
1444
+ },
1445
+ "choices": null,
1446
+ "placeholder": null,
1447
+ "properties": null,
1448
+ "category": null,
1449
+ "depends_on": null,
1450
+ "readOnly": null,
1451
+ "hidden": null,
1452
+ "minimum": null,
1453
+ "maximum": null,
1454
+ "defaultObjectUI": null,
1455
+ "disabledInputMethods": null,
1456
+ "displayMode": null,
1457
+ "format": "date",
1458
+ "additionalProperties": false
1459
+ },
1460
+ "coupon": {
1461
+ "label": "Coupon Code",
1462
+ "description": "Coupon code that customer supplied when they signed up.",
1463
+ "type": "string",
1464
+ "required": false,
1465
+ "multiple": false,
1466
+ "allowNull": false,
1467
+ "dynamic": false,
1468
+ "default": {
1469
+ "@path": "$.properties.coupon"
1470
+ },
1471
+ "choices": null,
1472
+ "placeholder": null,
1473
+ "properties": null,
1474
+ "category": null,
1475
+ "depends_on": null,
1476
+ "readOnly": null,
1477
+ "hidden": null,
1478
+ "minimum": null,
1479
+ "maximum": null,
1480
+ "defaultObjectUI": null,
1481
+ "disabledInputMethods": null,
1482
+ "displayMode": null,
1483
+ "format": null,
1484
+ "additionalProperties": false
1485
+ },
1486
+ "attributionId": {
1487
+ "label": "Friendbuy Attribution ID",
1488
+ "description": "Friendbuy attribution ID that associates the customer who is signing up with the advocate who referred them.",
1489
+ "type": "string",
1490
+ "required": false,
1491
+ "multiple": false,
1492
+ "allowNull": false,
1493
+ "dynamic": false,
1494
+ "default": {
1495
+ "@path": "$.properties.attributionId"
1496
+ },
1497
+ "choices": null,
1498
+ "placeholder": null,
1499
+ "properties": null,
1500
+ "category": null,
1501
+ "depends_on": null,
1502
+ "readOnly": null,
1503
+ "hidden": null,
1504
+ "minimum": null,
1505
+ "maximum": null,
1506
+ "defaultObjectUI": null,
1507
+ "disabledInputMethods": null,
1508
+ "displayMode": null,
1509
+ "format": null,
1510
+ "additionalProperties": false
1511
+ },
1512
+ "referralCode": {
1513
+ "label": "Friendbuy Referral ID",
1514
+ "description": "Friendbuy referral code that associates the customer who is signing up with the advocate who referred them.",
1515
+ "type": "string",
1516
+ "required": false,
1517
+ "multiple": false,
1518
+ "allowNull": false,
1519
+ "dynamic": false,
1520
+ "default": {
1521
+ "@path": "$.properties.referralCode"
1522
+ },
1523
+ "choices": null,
1524
+ "placeholder": null,
1525
+ "properties": null,
1526
+ "category": null,
1527
+ "depends_on": null,
1528
+ "readOnly": null,
1529
+ "hidden": null,
1530
+ "minimum": null,
1531
+ "maximum": null,
1532
+ "defaultObjectUI": null,
1533
+ "disabledInputMethods": null,
1534
+ "displayMode": null,
1535
+ "format": null,
1536
+ "additionalProperties": false
1537
+ },
1538
+ "friendbuyAttributes": {
1539
+ "label": "Custom Attributes",
1540
+ "description": "Custom attributes to send to Friendbuy. You should pass an object whose keys are the names of the custom attributes and whose values are strings. Non-string-valued attributes will be dropped.",
1541
+ "type": "object",
1542
+ "required": false,
1543
+ "multiple": false,
1544
+ "allowNull": false,
1545
+ "dynamic": false,
1546
+ "default": {
1547
+ "@path": "$.properties.friendbuyAttributes"
1548
+ },
1549
+ "choices": null,
1550
+ "placeholder": null,
1551
+ "properties": null,
1552
+ "category": null,
1553
+ "depends_on": null,
1554
+ "readOnly": null,
1555
+ "hidden": null,
1556
+ "minimum": null,
1557
+ "maximum": null,
1558
+ "defaultObjectUI": null,
1559
+ "disabledInputMethods": null,
1560
+ "displayMode": null,
1561
+ "format": null,
1562
+ "additionalProperties": false
1563
+ }
1564
+ }
1565
+ },
1566
+ "trackPage": {
1567
+ "title": "Track Page",
1568
+ "description": "Record when a customer visits a new page. Allow Friendbuy widget targeting by Page Name instead of URL.",
1569
+ "platform": "web",
1570
+ "defaultSubscription": "type = \"page\"",
1571
+ "hidden": false,
1572
+ "hasPerformBatch": false,
1573
+ "syncMode": null,
1574
+ "hooks": null,
1575
+ "dynamicFields": null,
1576
+ "fields": {
1577
+ "name": {
1578
+ "label": "Page Name",
1579
+ "description": "The page name.",
1580
+ "type": "string",
1581
+ "required": false,
1582
+ "multiple": false,
1583
+ "allowNull": false,
1584
+ "dynamic": false,
1585
+ "default": {
1586
+ "@path": "$.name"
1587
+ },
1588
+ "choices": null,
1589
+ "placeholder": null,
1590
+ "properties": null,
1591
+ "category": null,
1592
+ "depends_on": null,
1593
+ "readOnly": null,
1594
+ "hidden": null,
1595
+ "minimum": null,
1596
+ "maximum": null,
1597
+ "defaultObjectUI": null,
1598
+ "disabledInputMethods": null,
1599
+ "displayMode": null,
1600
+ "format": null,
1601
+ "additionalProperties": false
1602
+ },
1603
+ "category": {
1604
+ "label": "Page Category",
1605
+ "description": "The page category.",
1606
+ "type": "string",
1607
+ "required": false,
1608
+ "multiple": false,
1609
+ "allowNull": false,
1610
+ "dynamic": false,
1611
+ "default": {
1612
+ "@path": "$.category"
1613
+ },
1614
+ "choices": null,
1615
+ "placeholder": null,
1616
+ "properties": null,
1617
+ "category": null,
1618
+ "depends_on": null,
1619
+ "readOnly": null,
1620
+ "hidden": null,
1621
+ "minimum": null,
1622
+ "maximum": null,
1623
+ "defaultObjectUI": null,
1624
+ "disabledInputMethods": null,
1625
+ "displayMode": null,
1626
+ "format": null,
1627
+ "additionalProperties": false
1628
+ },
1629
+ "title": {
1630
+ "label": "Page Title",
1631
+ "description": "The page title.",
1632
+ "type": "string",
1633
+ "required": false,
1634
+ "multiple": false,
1635
+ "allowNull": false,
1636
+ "dynamic": false,
1637
+ "default": {
1638
+ "@path": "$.properties.title"
1639
+ },
1640
+ "choices": null,
1641
+ "placeholder": null,
1642
+ "properties": null,
1643
+ "category": null,
1644
+ "depends_on": null,
1645
+ "readOnly": null,
1646
+ "hidden": null,
1647
+ "minimum": null,
1648
+ "maximum": null,
1649
+ "defaultObjectUI": null,
1650
+ "disabledInputMethods": null,
1651
+ "displayMode": null,
1652
+ "format": null,
1653
+ "additionalProperties": false
1654
+ }
1655
+ }
1656
+ },
1657
+ "trackCustomEvent": {
1658
+ "title": "Track Custom Event",
1659
+ "description": "Record when a customer completes any custom event that you define.",
1660
+ "platform": "web",
1661
+ "defaultSubscription": null,
1662
+ "hidden": false,
1663
+ "hasPerformBatch": false,
1664
+ "syncMode": null,
1665
+ "hooks": null,
1666
+ "dynamicFields": null,
1667
+ "fields": {
1668
+ "eventType": {
1669
+ "label": "Event Type",
1670
+ "description": "The type of the event to track.",
1671
+ "type": "string",
1672
+ "required": true,
1673
+ "multiple": false,
1674
+ "allowNull": false,
1675
+ "dynamic": false,
1676
+ "default": {
1677
+ "@path": "$.event"
1678
+ },
1679
+ "choices": null,
1680
+ "placeholder": null,
1681
+ "properties": null,
1682
+ "category": null,
1683
+ "depends_on": null,
1684
+ "readOnly": null,
1685
+ "hidden": null,
1686
+ "minimum": null,
1687
+ "maximum": null,
1688
+ "defaultObjectUI": null,
1689
+ "disabledInputMethods": null,
1690
+ "displayMode": null,
1691
+ "format": null,
1692
+ "additionalProperties": false
1693
+ },
1694
+ "eventProperties": {
1695
+ "label": "Event Properties",
1696
+ "description": "Object containing the properties for the event being tracked. All of the fields in this object will be sent in the root of the Friendbuy track event.",
1697
+ "type": "object",
1698
+ "required": true,
1699
+ "multiple": false,
1700
+ "allowNull": false,
1701
+ "dynamic": false,
1702
+ "default": {
1703
+ "@path": "$.properties"
1704
+ },
1705
+ "choices": null,
1706
+ "placeholder": null,
1707
+ "properties": null,
1708
+ "category": null,
1709
+ "depends_on": null,
1710
+ "readOnly": null,
1711
+ "hidden": null,
1712
+ "minimum": null,
1713
+ "maximum": null,
1714
+ "defaultObjectUI": null,
1715
+ "disabledInputMethods": null,
1716
+ "displayMode": null,
1717
+ "format": null,
1718
+ "additionalProperties": false
1719
+ },
1720
+ "deduplicationId": {
1721
+ "label": "Event ID",
1722
+ "description": "An identifier for the event being tracked to prevent the same event from being rewarded more than once.",
1723
+ "type": "string",
1724
+ "required": false,
1725
+ "multiple": false,
1726
+ "allowNull": false,
1727
+ "dynamic": false,
1728
+ "default": {
1729
+ "@path": "$.properties.deduplicationId"
1730
+ },
1731
+ "choices": null,
1732
+ "placeholder": null,
1733
+ "properties": null,
1734
+ "category": null,
1735
+ "depends_on": null,
1736
+ "readOnly": null,
1737
+ "hidden": null,
1738
+ "minimum": null,
1739
+ "maximum": null,
1740
+ "defaultObjectUI": null,
1741
+ "disabledInputMethods": null,
1742
+ "displayMode": null,
1743
+ "format": null,
1744
+ "additionalProperties": false
1745
+ },
1746
+ "customerId": {
1747
+ "label": "Customer ID",
1748
+ "description": "The user's customer ID.",
1749
+ "type": "string",
1750
+ "required": true,
1751
+ "multiple": false,
1752
+ "allowNull": false,
1753
+ "dynamic": false,
1754
+ "default": {
1755
+ "@if": {
1756
+ "exists": {
1757
+ "@path": "$.properties.customerId"
1758
+ },
1759
+ "then": {
1760
+ "@path": "$.properties.customerId"
1761
+ },
1762
+ "else": {
1763
+ "@path": "$.userId"
1764
+ }
1765
+ }
1766
+ },
1767
+ "choices": null,
1768
+ "placeholder": null,
1769
+ "properties": null,
1770
+ "category": null,
1771
+ "depends_on": null,
1772
+ "readOnly": null,
1773
+ "hidden": null,
1774
+ "minimum": null,
1775
+ "maximum": null,
1776
+ "defaultObjectUI": null,
1777
+ "disabledInputMethods": null,
1778
+ "displayMode": null,
1779
+ "format": null,
1780
+ "additionalProperties": false
1781
+ },
1782
+ "anonymousId": {
1783
+ "label": "Anonymous ID",
1784
+ "description": "The user's anonymous id",
1785
+ "type": "string",
1786
+ "required": false,
1787
+ "multiple": false,
1788
+ "allowNull": false,
1789
+ "dynamic": false,
1790
+ "default": {
1791
+ "@path": "$.anonymousId"
1792
+ },
1793
+ "choices": null,
1794
+ "placeholder": null,
1795
+ "properties": null,
1796
+ "category": null,
1797
+ "depends_on": null,
1798
+ "readOnly": null,
1799
+ "hidden": null,
1800
+ "minimum": null,
1801
+ "maximum": null,
1802
+ "defaultObjectUI": null,
1803
+ "disabledInputMethods": null,
1804
+ "displayMode": null,
1805
+ "format": null,
1806
+ "additionalProperties": false
1807
+ },
1808
+ "email": {
1809
+ "label": "Email",
1810
+ "description": "The user's email address.",
1811
+ "type": "string",
1812
+ "required": false,
1813
+ "multiple": false,
1814
+ "allowNull": false,
1815
+ "dynamic": false,
1816
+ "default": {
1817
+ "@path": "$.properties.email"
1818
+ },
1819
+ "choices": null,
1820
+ "placeholder": null,
1821
+ "properties": null,
1822
+ "category": null,
1823
+ "depends_on": null,
1824
+ "readOnly": null,
1825
+ "hidden": null,
1826
+ "minimum": null,
1827
+ "maximum": null,
1828
+ "defaultObjectUI": null,
1829
+ "disabledInputMethods": null,
1830
+ "displayMode": null,
1831
+ "format": null,
1832
+ "additionalProperties": false
1833
+ }
1834
+ }
1835
+ }
1836
+ },
1837
+ "presets": [
1838
+ {
1839
+ "name": "Track Customer",
1840
+ "type": "automatic",
1841
+ "partnerAction": "trackCustomer",
1842
+ "subscribe": "type = \"identify\"",
1843
+ "mapping": {
1844
+ "customerId": {
1845
+ "@path": "$.userId"
1846
+ },
1847
+ "anonymousId": {
1848
+ "@path": "$.anonymousId"
1849
+ },
1850
+ "email": {
1851
+ "@path": "$.traits.email"
1852
+ },
1853
+ "firstName": {
1854
+ "@path": "$.traits.firstName"
1855
+ },
1856
+ "lastName": {
1857
+ "@path": "$.traits.lastName"
1858
+ },
1859
+ "name": {
1860
+ "@path": "$.traits.name"
1861
+ },
1862
+ "age": {
1863
+ "@path": "$.traits.age"
1864
+ },
1865
+ "birthday": {
1866
+ "@path": "$.traits.birthday"
1867
+ },
1868
+ "language": {
1869
+ "@path": "$.traits.language"
1870
+ },
1871
+ "addressCountry": {
1872
+ "@path": "$.traits.address.country"
1873
+ },
1874
+ "addressState": {
1875
+ "@path": "$.traits.address.state"
1876
+ },
1877
+ "addressCity": {
1878
+ "@path": "$.traits.address.city"
1879
+ },
1880
+ "addressPostalCode": {
1881
+ "@path": "$.traits.address.postalCode"
1882
+ },
1883
+ "customerSince": {
1884
+ "@path": "$.traits.customerSince"
1885
+ },
1886
+ "loyaltyStatus": {
1887
+ "@path": "$.traits.loyaltyStatus"
1888
+ },
1889
+ "isNewCustomer": {
1890
+ "@path": "$.traits.isNewCustomer"
1891
+ },
1892
+ "friendbuyAttributes": {
1893
+ "@path": "$.traits.friendbuyAttributes"
1894
+ }
1895
+ },
1896
+ "eventSlug": null
1897
+ },
1898
+ {
1899
+ "name": "Track Purchase",
1900
+ "type": "automatic",
1901
+ "partnerAction": "trackPurchase",
1902
+ "subscribe": "event = \"Order Completed\"",
1903
+ "mapping": {
1904
+ "orderId": {
1905
+ "@path": "$.properties.order_id"
1906
+ },
1907
+ "amount": {
1908
+ "@path": "$.properties.total"
1909
+ },
1910
+ "currency": {
1911
+ "@path": "$.properties.currency"
1912
+ },
1913
+ "coupon": {
1914
+ "@path": "$.properties.coupon"
1915
+ },
1916
+ "attributionId": {
1917
+ "@path": "$.properties.attributionId"
1918
+ },
1919
+ "referralCode": {
1920
+ "@path": "$.properties.referralCode"
1921
+ },
1922
+ "giftCardCodes": {
1923
+ "@path": "$.properties.giftCardCodes"
1924
+ },
1925
+ "products": {
1926
+ "@path": "$.properties.products"
1927
+ },
1928
+ "customerId": {
1929
+ "@if": {
1930
+ "exists": {
1931
+ "@path": "$.properties.customerId"
1932
+ },
1933
+ "then": {
1934
+ "@path": "$.properties.customerId"
1935
+ },
1936
+ "else": {
1937
+ "@path": "$.userId"
1938
+ }
1939
+ }
1940
+ },
1941
+ "anonymousId": {
1942
+ "@path": "$.anonymousId"
1943
+ },
1944
+ "email": {
1945
+ "@path": "$.properties.email"
1946
+ },
1947
+ "isNewCustomer": {
1948
+ "@path": "$.properties.isNewCustomer"
1949
+ },
1950
+ "loyaltyStatus": {
1951
+ "@path": "$.properties.loyaltyStatus"
1952
+ },
1953
+ "firstName": {
1954
+ "@path": "$.properties.firstName"
1955
+ },
1956
+ "lastName": {
1957
+ "@path": "$.properties.lastName"
1958
+ },
1959
+ "name": {
1960
+ "@path": "$.properties.name"
1961
+ },
1962
+ "age": {
1963
+ "@path": "$.properties.age"
1964
+ },
1965
+ "birthday": {
1966
+ "@path": "$.properties.birthday"
1967
+ },
1968
+ "friendbuyAttributes": {
1969
+ "@path": "$.properties.friendbuyAttributes"
1970
+ }
1971
+ },
1972
+ "eventSlug": null
1973
+ },
1974
+ {
1975
+ "name": "Track Sign Up",
1976
+ "type": "automatic",
1977
+ "partnerAction": "trackSignUp",
1978
+ "subscribe": "event = \"Signed Up\"",
1979
+ "mapping": {
1980
+ "customerId": {
1981
+ "@if": {
1982
+ "exists": {
1983
+ "@path": "$.properties.customerId"
1984
+ },
1985
+ "then": {
1986
+ "@path": "$.properties.customerId"
1987
+ },
1988
+ "else": {
1989
+ "@path": "$.userId"
1990
+ }
1991
+ }
1992
+ },
1993
+ "anonymousId": {
1994
+ "@path": "$.anonymousId"
1995
+ },
1996
+ "email": {
1997
+ "@path": "$.properties.email"
1998
+ },
1999
+ "isNewCustomer": {
2000
+ "@path": "$.properties.isNewCustomer"
2001
+ },
2002
+ "loyaltyStatus": {
2003
+ "@path": "$.properties.loyaltyStatus"
2004
+ },
2005
+ "firstName": {
2006
+ "@path": "$.properties.firstName"
2007
+ },
2008
+ "lastName": {
2009
+ "@path": "$.properties.lastName"
2010
+ },
2011
+ "name": {
2012
+ "@path": "$.properties.name"
2013
+ },
2014
+ "age": {
2015
+ "@path": "$.properties.age"
2016
+ },
2017
+ "birthday": {
2018
+ "@path": "$.properties.birthday"
2019
+ },
2020
+ "coupon": {
2021
+ "@path": "$.properties.coupon"
2022
+ },
2023
+ "attributionId": {
2024
+ "@path": "$.properties.attributionId"
2025
+ },
2026
+ "referralCode": {
2027
+ "@path": "$.properties.referralCode"
2028
+ },
2029
+ "friendbuyAttributes": {
2030
+ "@path": "$.properties.friendbuyAttributes"
2031
+ }
2032
+ },
2033
+ "eventSlug": null
2034
+ },
2035
+ {
2036
+ "name": "Track Page",
2037
+ "type": "automatic",
2038
+ "partnerAction": "trackPage",
2039
+ "subscribe": "type = \"page\"",
2040
+ "mapping": {
2041
+ "name": {
2042
+ "@path": "$.name"
2043
+ },
2044
+ "category": {
2045
+ "@path": "$.category"
2046
+ },
2047
+ "title": {
2048
+ "@path": "$.properties.title"
2049
+ }
2050
+ },
2051
+ "eventSlug": null
2052
+ }
2053
+ ]
2054
+ }