addRestHeader

A Workflow Engine function that adds additional headers to an outbound request in a exportViaRest or sendViaRest workflow. This workflow must run before the exportViaRest or sendViaRest action to be effective.

This function is available as a feature of the Add-ons v2.2 download and later.

This function is available for alert and Situation workflows.

Back to Workflow Engine Functions Reference.Workflow Engine Functions Reference

Arguments

Workflow Engine function addRestHeader takes the following arguments:

Name

Required

Type

Description

name

yes

string

The header name.

value

yes

string

The header value.

Example

The following example demonstrates typical use of Workflow Engine function addRestHeader.

To add an header called “API key” with a value “1234567890ABCDEFGH”, set the following:

  • name : “API key”

  • value : “1234567890ABCDEFGH”

The UI translates your settings to the following JSON:

{"name":"API key","value":"1234567890ABCDEFGH"}