HTTP Sender

This destination connector sends an HTTP request to an external web server. The method, parameters, and headers can all be fully customized. Both Basic and Digest authentication (preemptive or reactive) are supported. Sending requests through a proxy server is also supported, even when using HTTPS. The HTTP payload can be written out as raw bytes, or converted using a specified charset. Responses can be automatically converted to XML, allowing multipart payloads to be parsed in a consistent and easy-to-use way. Additional options are available with the SSL Manager extension.

Supported property groups:

Destination Settings

Item	Name	Default Value	Description
A	URL		The URL of the HTTP server to send each message to.
B	Use Proxy Server	No	If enabled, requests are forwarded to the proxy server specified in the address/port fields below.
C	Proxy Address		The domain name or IP address of the proxy server to connect to.
D	Proxy Port		The port on which to connect to the proxy server.
E	Method	POST	The HTTP operation (POST / GET / PUT / DELETE / PATCH) to send for each message.
F	Multipart	No	If enabled, the content is first written to a local temp file and is then wrapped in a single file part inside a multipart/form-data payload.
G	Send Timeout (ms)	30000	Sets the socket timeout (SO_TIMEOUT) in milliseconds to be used executing the method. A timeout value of zero is interpreted as an infinite timeout.
H	Response Content	Plain Body	Plain Body: The response body will be stored as a raw string. XML Body: The response body will be stored as serialized XML.
I	Parse Multipart	Yes	Applies only to Response Content XML Body. Select Yes to automatically parse multipart responses into separate XML nodes. Select No to always keep the response body as a single XML node.
J	Include Metadata	No	Applies only to Response Content XML Body. Select Yes to include response metadata (response code, headers) in the XML content. Note: Regardless of this setting, the same metadata is always available in the connector map.
K	Binary MIME Types	application/.* (?<!json\|xml)$\| image/.\|video/.\| audio/.*	When a response comes in with a Content-Type header that matches one of these entries, the content is encoded into a Base64 string. If Regular Expression is unchecked, specify multiple entries with commas. If Regular Expression is checked, enter a valid regular expression to match MIME types against.
L	Authentication	No	If enabled, a Basic or Digest Authorization header is automatically added to the request.
M	Authentication Type	Basic	Select either Basic or Digest authentication type. If the Preemptive option is checked, the Authorization header is sent to the server with the initial request. If the Preemptive option is unchecked, the Authorization header is only sent when the server requests it. Note: When Digest authentication is selected, an Authorization header containing the realm/nonce/algorithm/qop values must be included in the Headers table.
N	Username		The username to use to authenticate to the HTTP server.
O	Password		The password to use to authenticate to the HTTP server.
P	Query Parameters	Use Table	Use Table: The table below will be used to populate query parameters. Use Map: The Java map specified by the following variable will be used to populate query parameters. The map must have String keys and either String or List<String> values. When using the Use Table option above, entries in this table will automatically be added to the request URI as query parameters. Multiple parameters with the same name are supported. Tip: If the "application/x-www-form-urlencoded" Content Type is used, this table will be used to populate the form data and will be sent in the entity payload rather than in the request URI.
Q	Headers	Use Table	Use Table: The table below will be used to populate headers. Use Map: The Java map specified by the following variable will be used to populate headers. The map must have String keys and either String or List<String> values. When using the Use Table option above, entries in this table will be added to the request as HTTP headers. Multiple headers with the same name are supported
R	Content Type	text/plain	The HTTP message body MIME type to use. If application/x-www-form-urlencoded is used, the query parameters specified above will be automatically encoded into the request body.
S	Data Type	Text	Select Binary if the outbound message is a Base64 string. This is decoded before it is sent out. Select Text if the outbound message is textual. This is encoded with the specified character set encoding.
T	Charset Encoding	UTF-8	Select the character set encoding to send with the Content-Type header, or Default to use the default character set encoding for the JVM Mirth® Connect is running on. If None is selected, no charset will be included in the Content-Type header unless explicitly specified in the Content Type field.
U	Content		The actual payload to send. Only applicable for entity-enclosing requests (POST / PUT / PATCH). Velocity Variable Replacement is supported here.

HTTP Sender

Supported property groups:

Destination Settings

Item	Name	Default Value	Description
A	URL		The URL of the HTTP server to send each message to.
B	Use Proxy Server	No	If enabled, requests are forwarded to the proxy server specified in the address/port fields below.
C	Proxy Address		The domain name or IP address of the proxy server to connect to.
D	Proxy Port		The port on which to connect to the proxy server.
E	Method	POST	The HTTP operation (POST / GET / PUT / DELETE / PATCH) to send for each message.
F	Multipart	No	If enabled, the content is first written to a local temp file and is then wrapped in a single file part inside a multipart/form-data payload.
G	Send Timeout (ms)	30000	Sets the socket timeout (SO_TIMEOUT) in milliseconds to be used executing the method. A timeout value of zero is interpreted as an infinite timeout.
H	Response Content	Plain Body	Plain Body: The response body will be stored as a raw string. XML Body: The response body will be stored as serialized XML.
I	Parse Multipart	Yes	Applies only to Response Content XML Body. Select Yes to automatically parse multipart responses into separate XML nodes. Select No to always keep the response body as a single XML node.
J	Include Metadata	No	Applies only to Response Content XML Body. Select Yes to include response metadata (response code, headers) in the XML content. Note: Regardless of this setting, the same metadata is always available in the connector map.
K	Binary MIME Types	application/.* (?<!json\|xml)$\| image/.\|video/.\| audio/.*	When a response comes in with a Content-Type header that matches one of these entries, the content is encoded into a Base64 string. If Regular Expression is unchecked, specify multiple entries with commas. If Regular Expression is checked, enter a valid regular expression to match MIME types against.
L	Authentication	No	If enabled, a Basic or Digest Authorization header is automatically added to the request.
M	Authentication Type	Basic	Select either Basic or Digest authentication type. If the Preemptive option is checked, the Authorization header is sent to the server with the initial request. If the Preemptive option is unchecked, the Authorization header is only sent when the server requests it. Note: When Digest authentication is selected, an Authorization header containing the realm/nonce/algorithm/qop values must be included in the Headers table.
N	Username		The username to use to authenticate to the HTTP server.
O	Password		The password to use to authenticate to the HTTP server.
P	Query Parameters	Use Table	Use Table: The table below will be used to populate query parameters. Use Map: The Java map specified by the following variable will be used to populate query parameters. The map must have String keys and either String or List<String> values. When using the Use Table option above, entries in this table will automatically be added to the request URI as query parameters. Multiple parameters with the same name are supported. Tip: If the "application/x-www-form-urlencoded" Content Type is used, this table will be used to populate the form data and will be sent in the entity payload rather than in the request URI.
Q	Headers	Use Table	Use Table: The table below will be used to populate headers. Use Map: The Java map specified by the following variable will be used to populate headers. The map must have String keys and either String or List<String> values. When using the Use Table option above, entries in this table will be added to the request as HTTP headers. Multiple headers with the same name are supported
R	Content Type	text/plain	The HTTP message body MIME type to use. If application/x-www-form-urlencoded is used, the query parameters specified above will be automatically encoded into the request body.
S	Data Type	Text	Select Binary if the outbound message is a Base64 string. This is decoded before it is sent out. Select Text if the outbound message is textual. This is encoded with the specified character set encoding.
T	Charset Encoding	UTF-8	Select the character set encoding to send with the Content-Type header, or Default to use the default character set encoding for the JVM Mirth® Connect is running on. If None is selected, no charset will be included in the Content-Type header unless explicitly specified in the Content Type field.
U	Content		The actual payload to send. Only applicable for entity-enclosing requests (POST / PUT / PATCH). Velocity Variable Replacement is supported here.

HTTP Sender

Recommendations

DICOM Sender

File Writer

Web Service Sender

SMTP Sender

TCP Sender

Database Writer

HTTP Sender

DICOM Sender

File Writer

Web Service Sender

SMTP Sender

TCP Sender

Database Writer