Custom Activity Configuration

In Journey Builder, both custom events and custom activities follow the same structure. For more information about creating custom events, see Considerations for Building Custom Events.

The config.json file includes the properties shown in this table. To view these properties in context, see the sample config.json file.

metaData Object Properties

Custom Activity Icon Details

The value of the icon property must be a path to an icon. The path can be an absolute URL or a path that’s relative to the URL of the custom activity.

If you don’t specify a value for the icon property, Journey Builder checks to see if a file called icon.png exists in the path that you specified for the custom activity. If that file doesn’t exist, it looks for a file called icon.svg in the same path. If that file doesn’t exist, Journey Builder uses a default icon.

Journey Builder always uses the icon value in the version of the config.json file hosted on your web server. If you add a custom activity to your journey, and then modify the configuration of that instance of the custom activity, Journey Builder doesn’t update the icon. If you change the value of the icon property in the config.json hosted on your web server, the icon is updated for all instances of that custom activity in the journey.

If you change the value of icon in the config.json served by your webserver, the icon is updated for all instances of that custom activity in the journey.

The icon file must meet these specifications.

• Supported file formats: .png, .svg, .jpg, .gif
• Maximum width and height: 40 pixels × 40 pixels
• File size limit: None

lang Object Properties

The lang object contains at least one object. The name of each object must equal the name of a BCP 47 locale code, such as en-US for US English or pt-BR for Brazilian Portuguese. In each object, you specify the name and description of the custom activity for the specified locale.

arguments Object Properties

configurationArguments Object Properties

configurationArgumentActivity Object Properties

Each of the actions in the configurationArguments object (publish, unpublish, save, validate, and stop) can contain the properties in this table.

userInterfaces Object Properties

The userInterfaces object contains information about the appearance of the configuration page for the custom activity in the journeys user interface.

wizardSteps Array Properties

The wizardSteps array contains objects that define the steps that the user navigates through as they configure the custom activity. Each object contains the values in this table.

This image shows a configuration page for a custom journey activity in fullscreen mode. The three numbered tabs ("Workflow", "Execute", and "Editor") correspond to the label values in the wizardSteps object.

schema Object Properties

The schema object specifies schema information about in and out arguments. The schema object has the structure shown in this example.

"schema": {
  "arguments": {
    "execute": {
      "inArguments": [
        "{inArgumentName}": {
          "dataType": "{dataType}",
          "isNullable": {true|false},
          "direction": "in",
          "access": "{visible|hidden}"
        }
      ],
      "outArguments": [
        "{outArgumentName}": {
          "dataType": "{dataType}",
          "isNullable": {true|false},
          "direction": "out",
          "access": "{visible|hidden}"
        }
      ]
    }
  }
}

The inArguments and outArguments arrays contain objects that specify the characteristics of each argument.

The context of the call determines the direction of the arguments in the schema. The values that you provide must match the execution context.

The outArguments can’t contain null values.

If the value of the access property parameter is set to hidden or isn’t specified, the argument isn’t shown in subsequent expression builders.

copySettings Object Properties

These are the properties of the copySettings object.

Sample config.json File

{
  "workflowApiVersion": "1.1",
  "name": "Custom Activity Name",
  "description": "Custom Activity Description",
  "metaData": {
    "icon": "images/icon.svg",
    "category": "Custom"
  },
  "type": "REST",
  "lang": {
    "en-US": {
      "name": "Localized Custom Activity Name",
      "description": "Localized Custom Activity Description",
      "label1": "Localized Step 1",
      "label2": "Localized Step 2",
      "label3": "Localized Step 3"
    }
  },
  "arguments": {
    "execute": {
      "inArguments": [
        {
          "staticValue": 0,
          "databoundEmailAddress": "{{Event.EventKey.EmailAddress}}"
        }
      ],
      "outArguments": [
        {
          "returnValue": "default"
        }
      ],
      "timeout": 10000,
      "retryCount": 1,
      "retryDelay": 1000,
      "concurrentRequests": 6,
      "url": "https://example.com/execute",
      "securityOptions": {
        "securityType": "securityContext",
        "securityContextKey": "EXTERNAL_KEY"
      }
    }
  },
  "configurationArguments": {
    "save": {
      "url": "https://example.com/save",
      "securityOptions": {
        "securityType": "securityContext",
        "securityContextKey": "EXTERNAL_KEY"
      }
    },
    "publish": {
      "url": "https://example.com/publish",
      "securityOptions": {
        "securityType": "securityContext",
        "securityContextKey": "EXTERNAL_KEY"
      }
    },
    "validate": {
      "url": "https://example.com/validate",
      "securityOptions": {
        "securityType": "securityContext",
        "securityContextKey": "EXTERNAL_KEY"
      }
    },
    "stop": {
      "url": "https://example.com/stop",
      "securityOptions": {
        "securityType": "securityContext",
        "securityContextKey": "EXTERNAL_KEY"
      }
    }
  },
  "wizardSteps": [
    {
      "label": "label1",
      "key": "step1"
    },
    {
      "label": "label2",
      "key": "step2"
    },
    {
      "label": "label3",
      "key": "step3",
      "active": false
    }
  ],
  "userInterfaces": {
    "configModal": {
      "fullscreen": true,
      "url": "configModal.html"
    },
    "runningModal": {
      "url": "runningModal.html"
    },
    "runningHover": {
      "url": "runningHover.html"
    }
  },
  "schema": {
    "arguments": {
      "execute": {
        "inArguments": [
          {
            "staticValue": {
              "dataType": "Number",
              "isNullable": false,
              "direction": "in"
            },
            "databoundEmailAddress": {
              "dataType": "Email",
              "isNullable": false,
              "direction": "in"
            }
          }
        ],
        "outArguments": [
          {
            "returnValue": {
              "dataType": "Text",
              "isNullable": false,
              "direction": "out"
            }
          }
        ]
      }
    }
  },
  "copySettings": {
    "allowCopy": true,
    "ignoreArguments": ["eventDefinitionKey"]
  }
}