Internationalize Custom Events

Custom events should have a summary array defined in their config.json under userInterfaces. The summary array is a collection of key-value pairs that maps to labels and values on the summary step of the event configuration modal and the event summary on the canvas.

1"summary": [
2    {
3        "valuePath": "arguments.countryCode",
4        "label": "countryCodeLabel"
5    },
6    {
7        "valuePath": "arguments.firstName",
8        "label": "firstNameLabel"
9    },
10    {
11        "valuePath": "arguments.lastName",
12        "label": "lastNameLabel"
13    },
14    {
15        "valuePath": "arguments.favoriteFood",
16        "label": "favoriteFoodLabel"
17    }
18]

Each valuePath maps to a value in the activity’s JSON.

Each label corresponds to an i18n key in the config’s lang object:

1"lang":{
2    "en-US": {
3        "name": " Contact Event (Workflow API v1.1)",
4        "description": "An example Contact event using workflow API v1.1 format.",
5        ...
6        "countryCodeLabel": "Country Code",
7        "firstNameLabel": "First Name",
8        "lastNameLabel": "Last Name",
9        "favoriteFoodLabel": "Favorite Food"
10    }
11}

These key-value pairs are displayed on the summary on the canvas, as well as the final step of the event selection wizard.

Example config.json Schema

1{
2  "fields": [
3    {
4      "name": "countryCode",
5      "dataType": "text",
6      "maxLength": "50",
7      "isNullable": false,
8      "defaultValue": ""
9    },
10    {
11      "name": "firstName",
12      "dataType": "text",
13      "maxLength": "100",
14      "isNullable": false,
15      "defaultValue": ""
16    },
17    {
18      "name": "lastName",
19      "dataType": "text",
20      "maxLength": "100",
21      "isNullable": false,
22      "defaultValue": ""
23    },
24    {
25      "name": "My Integer",
26      "dataType": "number",
27      "maxLength": "",
28      "isNullable": false,
29      "defaultValue": ""
30    },
31    {
32      "name": "My Date",
33      "dataType": "date",
34      "maxLength": "",
35      "isNullable": false,
36      "defaultValue": ""
37    },
38    {
39      "name": "My Bool",
40      "dataType": "boolean",
41      "maxLength": "",
42      "isNullable": false,
43      "defaultValue": "true"
44    },
45    {
46      "name": "My Email",
47      "dataType": "email",
48      "maxLength": "",
49      "isNullable": false,
50      "defaultValue": ""
51    },
52    {
53      "name": "My Phone",
54      "dataType": "phone",
55      "maxLength": "",
56      "isNullable": false,
57      "defaultValue": ""
58    },
59    {
60      "name": "My Decimal",
61      "dataType": "decimal",
62      "maxLength": "18,0",
63      "isNullable": false,
64      "defaultValue": ""
65    },
66    {
67      "name": "My Locale",
68      "dataType": "locale",
69      "maxLength": "",
70      "isNullable": false,
71      "defaultValue": ""
72    }
73  ],
74  "sendableCustomObjectField": "My Email",
75  "sendableSubscriberField": "_SubscriberKey"
76}