Skip to main content

HTTP Request

Use the HTTP Request step whenever your flow needs to call an external API, webhook, or web service. It’s the go-to action for integrations: fetch data from a partner system, push updates to a third-party app, or trigger downstream automation outside Business Central.

Typical use cases include:

  • Sending order data to a shipping provider.
  • Calling a validation service to enrich a customer record.
  • Triggering a webhook in a connected portal or middleware.

Configure the step​

Open the flow editor, add HTTP Request, and fill in the configuration card.

Description​

  • Purpose: Make it clear what this call does in the flow.
  • When to fill it: Always. The description is shown in the editor and execution history.
  • Tips: Include the target system and intent, for example, POST shipment to DHL.

Request URL​

  • Purpose: The endpoint your request will call.
  • When to fill it: Required. Without a URL, no call can be made.
  • Tips: Use full URLs, including protocol (https://). If the endpoint is dynamic, map it from previous step outputs or variables.

Request Method​

  • Purpose: Defines the HTTP verb used to call the endpoint.
  • When to fill it: Required. Choose the verb the API expects.
  • Tips: Use GET for reads, POST for creating data, PUT/PATCH for updates, and DELETE for removals. HEAD and OPTIONS are available for special cases.

Request Headers​

  • Purpose: Add metadata the API requires (authentication, content type, etc.).
  • When to fill it: Optional, but essential for most APIs.
  • How it works: Each entry is a name/value pair. Header names are selected from the predefined header list (such as Authorization, Content-Type, or Accept).
  • Tips: Set Content-Type when you send a body, and add Authorization for secured endpoints.

Request Body​

  • Purpose: The payload you send with the request.
  • When to fill it: Available only for POST, PUT, and PATCH. In these cases you usually need to fill it.
  • Tips: Use JSON for modern APIs, and match the structure expected by the endpoint. The body editor supports multi-line content for easy formatting.

Outputs​

The step returns three outputs you can use in later actions:

  • responseStatus: The HTTP status code as text.
  • responseHeaders: The response headers as JSON text.
  • responseBody: The response payload as text.

Use these outputs to branch your flow, log errors, or parse response data into business records.

Best practices​

  • Handle errors early: Check responseStatus and add a decision step for non-2xx responses.
  • Keep secrets safe: Store API keys in secure variables or key vaults, then reference them in headers.
  • Be explicit about formats: Always set Content-Type and Accept when the API is strict about media types.