Skip to content

HTTP connections, pagination, and triggers

HTTP automations exchange data with another system's API. Ask the provider for the request URL, method, authentication requirements, and response format. Configure only the settings that apply to that API, and use protected parameters for credentials.

Request and authentication

The connection object can contain address, method, headers, and payload. A provider may require an initial login or a token. The auth object can describe a token request using address, method, headers, payload, and token_key, the response path from which to read the token. OAuth integrations have separate authorization and refresh settings. Authentication requirements vary by provider; use the provider's current instructions.

ssl_http verifies the server's certificate and defaults to true. If a connection fails certificate verification, resolve the certificate issue with the provider rather than disabling verification.

Pagination

Some APIs return results in pages. Set paginate to true, or provide a nonempty pagination object, and configure it to match the provider's response:

  • next_token identifies the response value for the next page. next_parameter identifies a query parameter when the token is a value rather than a URL.
  • page_parameter, page_start, and page_iterator support page-number-based requests. The starting page and increment default to 1. A changed page parameter or increment selects page-number mode when the next-token setting remains at its default; changing page_start alone does not select that mode.
  • page_per_second limits the rate of paginated requests. For subsequent pages, a 404 ends pagination; ignore_errors: true also allows an HTTP 500 to end it. Its default is false. Either case can leave a partial result, so use these settings only when the provider's behavior makes that safe.

Confirm the total result and final page using a representative response. An incomplete source can be especially consequential if the automation also acts on products missing from the source.

Triggers

Some integrations need one or more preliminary requests before fetching the final data. The triggers array describes those requests in order. A trigger can specify its address, method, headers, and payload, along with key or numbered key entries to extract response values. It can also specify a retry limit and delay. Trigger values can be substituted into the subsequent connection configuration.

Test the complete sequence with the provider's test environment when available. A debug run can still contact the provider; confirm that the requests and destination are appropriate before testing.