Skip to main content

Request Parameters Overview

APIEase lets you pass data into requests in several ways so each run has the inputs it needs without exposing sensitive values.

  • In-app parameters: Static or confidential values stored securely in APIEase. Use these when the value rarely changes or must stay server-side.
  • Dynamic embedded parameters: Values provided at runtime from the storefront, webhooks, or other triggers (headers, query, path, body, flow, or Liquid). Use these for request-specific data like customer ids, page context, or user input.
  • Path variables: Placeholders in the request URL (/products/{id}) that are filled by in-app or dynamic embedded parameters when the request executes.
  • Chained request parameters: Data passed from the response of one request into the next request in a sequence.

Choose the parameter type based on where the value comes from and whether it must stay confidential. Combine these options to keep sensitive data secure while still letting each trigger supply the context it needs.

For Liquid requests, distinguish saved Liquid parameters from runtime embedded Liquid parameters:

  • Saved Liquid parameters are configured on the request and can be substituted with {parameterName} before execution. Use saved Liquid parameters for stored defaults, sensitive values, or other server-side configured values.
  • Runtime embedded Liquid parameters are supplied by a caller with liquidParamsEmbedded and are read in Liquid through apiEaseParameters.liquidParams.<parameterName>. Use liquidParamsEmbedded for per-call values supplied at runtime.