HTTP Pull
Most recent version: v0.0.1
Note that this Listener is only available in certain Tenants. Get in touch with us if you don't see it and want to access it.
Overview
Onum supports integration with HTTP Pull. Select HTTP Pull from the list of Listener types and click Configuration to start.
Configuration
Now you need to specify how and where to collect the data and how to establish an HTTP connection.
Metadata
Enter the basic information for the new Listener.
Name*
Enter a name for the new Listener.
Description
Optionally, enter a description for the Listener.
Tags
Add tags to easily identify your Listener. Hit the Enter key after you define each tag.
Configuration
Cloud Listeners
Note that you won't see the Socket and TLS configuration sections in the creation form if you're defining this Listener in a Cloud instance, as these are already provided by Onum. Learn more about Cloud Listeners in this article.
Parameters
Name
Enter the name of the parameter to search for in the YAML below, used later as ${parameters.name} e.g. ${parameters.domain}.
Value
Enter the value or variable to fill in when the given parameter name has been found, e.g. “domain.com”. With the name set as “domain” and the value set as “domain.com” , the expression to execute on the YAML would be: ${parameters.domain}., which will be automatically replaced by the variable. Add as many name and value pairs as required.
Secrets
Name
Enter the name of the parameter to search for in the YAML below, used later as ${secrets.name}.
Value
Select the Secret containing the connection credentials if you have added them previously, or select New Secret to add it. This will add this value as the variable when the field name is found in the YAML. Add as many as required.
Config as YAML
Toggle ON to configure the HTTP as a YAML and paste it here.
The system supports interpolated variables throughout the HTTP request building process using the syntax:
${prefix.name} Each building block may:
Use variables depending on its role (e.g., parameters, secrets, pagination state).
Expose variables for later phases (e.g., pagination counters, temporal window bounds).
Not all variable types are available in every phase. Each block has access to a specific subset of variables.
Variables can be defined in the configuration or generated dynamically during execution. Each variable has a prefix that determines its source and scope.
Supported Prefixes:
User-defined values configured manually.
Available in all phases.
Sensitive values such as credentials or tokens.
Available in all phases
Automatically generated from the Temporal Window block.
Available in Enumeration and Collection phases.
Values produced by the pagination mechanism (e.g., offset, cursor).
Available in Enumeration and Collection phases.
Values derived from the output of the Enumeration phase.
Available only in the Collection phase.
If you do not have a YAML to paste and will manually configure the various components of a YAML, read the following article on how to use each individual toggle:
Ports
The HTTP Pull sink has two output ports:
Default port - Events are sent through this port if no error occurs while processing them.
Error port - Events are sent through this port if an error occurs while processing them.
The error message is provided in a free-text format and may change over time. Please consider this if performing any post-processing based on the message content.
Last updated
Was this helpful?