Configure a Webhook Campaign: Message

Overview

Unlike most other channels in Engage+, the Message sub-section is not used to define the creative content of your marketing message. Instead, this sub-section is used to define the payload of the Campaign's HTTP request message.

Features

The features and options available from the Message sub-section are described below.

Enter Content

Define Message Payload

Click hereClick here

To define the payload of your Webhook Campaign:

In the "Request URL" field, enter the endpoint for the HTTP Request.
From the "HTTP Method" drop-down menu, select the desired HTTP Method -- GET, POST, PUT, PATCH, HEAD, or DELETE.
The "Content-type" field is populated with the default MIME type of the body of the request. Optionally, you can edit this value as needed. This value will be inserted into the request header.
The "User-Agent" field is populated with the default value of "MarigoldEngage+/{currentVersion} (+https://www.meetmarigold.com)", for example, "MarigoldEngage+/23.6.0 (+https://www.meetmarigold.com)" . This field is not mandatory. However, if you need to use the webhooks for your Journeys, this value is required.
Engage+ supports the following two Data Type options that control the format of the HTTP request message you want to send, and whether the message payload should be appended to the request URL, or sent within the message body.

Append Payload to the URLAppend Payload to the URL

This option allows you to build a simple, custom HTTP request message containing whatever data fields are needed. The fields and their associated values are submitted as key-value pairs, contained within the header of the HTTP request, rather than in the body. The key-value pairs will be appended to the request URL, and any body text provided in the message will be ignored.

From the "Data Type" drop-down menu, select "Key Value Pair."
Within the "Header" section, in the "New Param Name" field, enter a header field name.
In the "New Param Value" field, enter the header field value. You can either enter a static value, or use Personalization options.
Click the add button (plus-sign icon) to add the key-value pair.
Repeat the above steps as needed to define additional header key-value pairs.
Within the "Parameter" section, in the "New Param Name" field, enter a field name.
In the "New Param Value" field, enter the header field value. You can either enter a static value, or use Personalization options.
Click the add button (plus-sign icon) to add the key-value pair.
Repeat the above steps as needed to define additional key-value pairs.
If you need to remove a key-value pair, click the remove button ("X" icon) next to the key-value pair. You can also rearrange the key-value pairs by dragging-and-dropping the gray box. The sequence that the key-value pairs appear on the screen controls the sequence of the key-value pairs within the HTTP message.

Send Payload in the BodySend Payload in the Body

This option allows you to define a text payload, usually JSON, that gets sent in the body of the message. This option allows you to send more structured data.

From the "Data Type" drop-down menu, select "Body Text." Please note that this option isn't available if the selected HTTP Method is GET.
Within the "Header" section, in the "New Param Name" field, enter a header field name.
In the "New Param Value" field, enter the header field value. You can either enter a static value, or use Personalization options.
Click the add button (plus-sign icon) to add the key-value pair.
Repeat the above steps as needed to define additional header key-value pairs.
If you need to remove a key-value pair, click the remove button ("X" icon) next to the key-value pair. You can also rearrange the key-value pairs by dragging-and-dropping the gray box. The sequence that the key-value pairs appear on the screen controls the sequence of the key-value pairs within the HTTP message.
Enter your JSON payload in the "Body" text field. You can also use Personalization options in the "Body" field.

Add Personalization Fields

Click hereClick here

Personalization fields are used to populate a portion of your message with values pulled from your database. For example, instead of "Dear Customer" as a greeting, you could replace the word "Customer" with the customer's actual first name.

The available personalization fields are displayed within the Personalization Pane on the right-hand side of the screen. This pane appears only if you've placed the cursor in a text field that supports personalization.

To add personalization to your marketing message:

Place your cursor in the field where you want to add personalization. The Personalization Pane appears on the right-hand side of the screen. Within this panel, the available fields are organized into different expandable / collapsible groups. For example, you'll see a section for your Campaign source table. You may see another section called "Joins" if your source table is joined to another table, or a section called "System Fields" that contains system-generated fields, or a section called "Metadata Fields" that contains the Metadata fields defined in your account.
Within the Personalization Pane, expand the desired group.
Double-click on the personalization field name (or, optionally, you can drag the desired personalization field from the Personalization Pane, and drop it into the text field). An "Insert Field Value" dialog box is displayed.
Optionally, enter a default value for this personalization field in the "Default" text box. The default value is used if a record doesn't have a valid value in the field being used to personalize the message.
Optionally select a formatting mask from the "Formatter" drop-down menu. The formatting mask is used to control the appearance of the text in the personalization field. For example, you can format date fields as "mm/dd/yyyy." The system includes formatting masks for dollar amounts, dates, numbers, and URLs. You can also use a formatting mask to truncate or encode the personalization field.
Click ok. The system creates a new Merge Symbol for this personalization field within the Clipboard section of the Personalization Pane. A Merge Symbol is a textual representation of the personalization field, consisting of the field name enclosed in double-brackets. For example: {(first_name)}. If you defined a default value, this value is also displayed within the Merge Symbol. For example: {(first_name|Customer)}
Within the message field, place your cursor where you want to insert the personalization field, then click the Merge Symbol for that field in the Clipboard. The system inserts the corresponding Merge Symbol into the message at the indicated position.

Configure PURL Options

Click hereClick here

A Personalized URL (or "PURL") is a website address that contains one or more personalized elements, such as the consumer's first name and last name, for example.

Before you can use a PURL in your Campaign, you must complete the following setup steps:

Create a PURL Field
Bind that PURL Field to a PURL Domain
Assign the PURL Domain to a Web Form

After you've completed all those steps, you can bind the Web Form to your Campaign. When you bind the Web Form to the Campaign, the platform will automatically generate the values for the PURL Field.

To bind the Web Form to your Campaign:

In the Tool Ribbon, click Options > Add PURL Options. Within the "Message" section of the Campaign screen, the system adds a new "PURL Setup" section.
The "PURL" field is used to select the Web Form. Either begin typing in the form name, or click the search button (magnifying glass icon) to search for it.
From the "URL Type" drop-down menu, select either "Prefix" or "Suffix" to control where you want the personalization fields inserted into the URL.

For more information on setting up Personalized URLs, see the PURL Domains topic.

Back to Configure a Webhook Campaign