Payloads

You can use this integration to:

  • Define mapping between an alert or Situation and the keys in a JSON payload.

  • Use with Workflow Engine actions. For example, to create a payload that can send alert or Situation data to an external system.

The payload map configuration follows a similar pattern to LAM mapping. A configuration consists of name:rule pairs. The rule is macro enabled to allow conversion or modification of the alert or Situation values.

A payload map can also contain multiple rules. The resulting JSON payload consists of key:value pairs based on these rules.

Before You Begin

Before you start to set up your integration, ensure you know the following about your payload map:

  • A Map Name for your payload map. For example, "My REST Mapping".

  • The keys for your resulting payload. Use these as the rule name.

  • The values for your resulting payload. These serve as rules and allow you to use a predefined set of macros.

  • Any default value, if any, you want for a key.

Configure the Payloads Integration

You can configure multiple payload maps from the Payloads integration. To configure the integration:

  1. Navigate to the Integrations tab.

  2. Click Payloads in the Reporting and Dashboards section.

  3. Provide a unique integration name. You can use the default name or customize the name according to your needs.

  4. Enter the details for each payload map you want to configure.

See Configure Payload Mapping Rules and Macros Reference for more information on mapping rules and macros.

After you complete the configuration, you can use payload maps in your workflows. For example, you can use the getPayload action to generate a payload from an alert or Situation. Use the map name from your configuration when the workflow action requires the map name.