HTTP Requests

HTTP API requests are highly configurable with many options. HTTP requests allow you to securely call any external API directly from your Shopify store or through other trigger methods such as webhooks, storefront app proxy, or a recurring schedule.

HTTP Request Fields

• Name: Optional display name. Required if this request is called by name from a chained request.

• Type: Set to http for a standard API call to an external service.

• Address: Full endpoint of the external API (for example, https://api.example.com/data).

• Method: Choose GET, POST, DELETE, PUT, PATCH, or OPTIONS.

• Parameters (?):

  • Headers: Add required headers (Authorization, Content-Type, etc.).
  • Query parameters: Values to include in the query string.
  • Body: For POST/PUT style calls; accept raw JSON or form fields.
  • Path: Dynamic path variables to substitute into the address.
  • System: Used by APIEase for features such as Customer Authentication.
  • You can provide in app parameters or pass dynamic embedded parameters from the storefront.
  • If the request includes credentials or API keys, mark them as Sensitive so they remain encrypted and never shown in the storefront or admin UI.

• Triggers (?): Choose how the request should be triggered:

  • Automatically via webhook
  • On a recurring schedule using cron
  • As an endpoint served by APIEase via Proxy Endpoints
  • Remotely from any http client.
  • Manually via the "Copy and Execute" link on the requests admin page
  • From your storefront using Shopify's app proxy

• Next Request: You can implement chained requests by setting the Next Request field to the name of a request to run after this one completes.