REST (Custom) Activity Format

The REST activity can be used to extend Journey Builder functionality. It works by posting request bodies to external endpoints.

Journey Specification Format

The activity must be formatted as specified below. The following JSON object is included in the activities array of a journey, as defined in the Journey Specification.

Helpful Hints

• The outcome of this decision affects goal statistics.
• If the useJwt property is set to true for any of the REST activity's methods, then a JWT for the account is generated, encoded, and sent as the POST body.
• If the execute method timeout is greater than the maximum allowed for the account, then use the maximum timeout value as configured in the account settings.
• The maximum timeout for the custom activity is 100,000 milliseconds. See Custom Activity Configuration for more details.

Compatibility Information

This information is provided for developers upgrading their activities from the legacy format to the Journey Specification.

Sample Activity

{
    "key": "rest-1",
    "name": "My Rest Activity",
    "type": "Rest",
    "metaData": {
        "flowDisplayName":"myFlow" // Displayed in the UI
    },
    "outcomes": [
        {
            "key": "rest-1-outcome-1",
            "next": "<key of next activity>"
        }
    ],
    "configurationArguments": {
        "save": {
            "url": "https://www.example.com/endpoint",
            "useJwt": false,
            "timeout": 3000,
            "headers": "https://www.example.com/endpoint",
            "body":"Hello"
        },
        "validate": {
            "url": "https://www.example.com/endpoint",
            "useJwt": false,
            "timeout": 3000,
            "headers": "https://www.example.com/endpoint",
            "body":"Hello"
        },
        "publish": {
            "url": "https://www.example.com/endpoint",
            "useJwt": false,
            "timeout": 3000,
            "headers": "https://www.example.com/endpoint",
            "body":"Hello"  
        }
    },
    "arguments": {      
        "execute": {
            "url": "https://www.example.com/endpoint",
            "headers": "",
            "inArguments": [{
                 "myArgument":""
             }],
            "body":"Hello . This field kept for backward compatibility.", // notice the Data Binding
            "method": "POST",
            "useJwt": true,
            "timeout": 3000
        }
    }
}

Related Items

• Custom Activities
• Encode Custom Activities Using a JWT
• Journey Specification