This job sends an HTTP request to an external server.

This job provides an external server with information from the Engage system or from an event.

Use this job when you want to send information about a system user to an external server. If you want to send information about contact activity to an external server, use the following job: Send HTTP Request - Contact (C)​.

The methods GET and POST are supported. If you create a POST request, you can add additional complex parameters to the request in XML or JSON. The parameters can include Engage placeholders.

Hint:

In Engage, the designation ​(S)​ means system-related. Generally, you only combine ​system (S) events​ with ​system (S) jobs​. For more information, see Contact (C) vs. System (S) Automations​

General

​Name​

Displays the name of the automation that is defined in the ​Edit Event​ window.

​Description​

Displays the description of the automation that is defined in the ​Edit Event​ window.

​Event​

Displays the event that is defined in the ​Edit Event​ window. Every time this event occurs, Engage executes the dependent job.

​Job​

Defines the job. Engage executes this job automatically every time the event occurs. For a list of all available jobs, see ​All Available Event-Based Jobs​.

Define Job​

This area defines the specific parameters of the job.

Setting

Description

​URL​

Defines the URL to which the request is sent. Example: https://website.com/linkclicks?

​Method​

Defines whether the request method is GET or POST.

​Encoding of Request​

Defines the character encoding of the values in the request. Depending on the language, the encoding must be able to transmit any special characters.

​Add Parameters​

This area adds new parameter fields to the window. Parameters add almost any kind of information to the request as Query / URL parameters. This value can be data from Engage or information from the event. You can add up to 10 additional parameters.

  • ​First field:​ This field adds additional query string parameters to the request URL. The parameter names can be freely defined but must begin with ​http_​. Examples: ​ http_opentimestamp​ or ​http_linkURL​.

  • ​Second field:​ Defines the value that Engage transmits in the request. This value can be a static value, an Engage attribute, or information from the event.

    • ​Static Value:​ Any value can be entered in the second field. The selected encoding must support the characters in the value.

    • ​Event Information:​ When the ​Use Event Parameter​ check box is selected, a drop-down list appears. The parameters in the drop-down list show the event values that can be included in the request. The options that are available vary depending on the event and only work with GET requests.

    • ​Standard Attributes:​ Adds the value from the defined standard attribute to the request. For example, <%user.email%>. Use percent-encoding to replace unsupported characters in the attribute placeholders URL. For example, ${ecm:urlEncode(user['Email'])} as the value of the second field.

    • ​Custom Attributes:​ <%user.customuserattribute.name%> adds the value from the respective custom attribute to the request. Use percent-encoding to replace unsupported characters in the attribute placeholders URL. For example, ${ecm:urlEncode(user['Email'])} as value of the second field.

    • ​Member Attributes:​ <%user.memberattribute.name%> adds the value from the respective member attribute to the request. Use percent-encoding to replace unsupported characters in the attribute placeholders URL. For example, ${ecm:urlEncode(user['Email'])} as value of the second field.

​Transfer Security Record​

Selects a transfer security record for the HTTP request. For more information, see Credentials Options​.

​Parameter Type​

This field is available for POST requests. You can select between JSON or XML.

​Parameter Value​

Defines additional complex parameters for the request. This value can include Engage placeholders.

​Transfer Security Record​

Defines the transfer security record that is used for the request. For more information, see Credentials Options​.

​System User​

Selects a system user ID to be transmitted in the HTTP request. Select the​ Use Event Parameter​ check box to transmit the system user ID from the event in the HTTP request. This field is only visible if the event was also a system event, marked with an (S) at the end of the name.

​Group ID​

Selects a group ID to be transmitted in the HTTP request. Select the​ Use Event Parameter​ check box to transmit the group ID from the event in the HTTP request (not available for all events).

​Message ID​

Selects a message ID to be transmitted in the HTTP request. Select the ​Use Event Parameter​ check box to transmit the message ID from the event in the HTTP request (not available for all events).

​Link ID​

Selects a link ID to be transmitted in the HTTP request. Select the​ Use Event Parameter​ check box to transmit the link from the event in the HTTP request (not available for all events).

​Log Response​

This input field defines whether the requests, errors, and server responses are logged. By using the ​Log Responses​ option, it is possible to determine whether single message sendout was successful or produced an error.


Define Delay​

In this area, you can define a time delay between the event and the resulting job. If you define a delay, the system waits the specified amount of time after the event takes place before executing the event-based job. If you do not define a delay, the system executes the job immediately after the event takes place.

Hint:

Engage calculates the selection for an event-based job when the job is executed, not when the event takes place. When you define a delay, the selection is calculated after the delay


  • ​Delay:​ Defines whether there is a delay between the event and the resulting job.

    • ​No: ​There is no delay between the event and the resulting job. When Engage registers the event, the system executes the job immediately.

    • ​Yes: ​Creates a delay between the event and the resulting job.
      ​Unit:​ Defines the unit of time with which Engage calculates the delay.
      ​Value:​ Defines the duration of the delay.

Actions

The following actions are available: