App Request

The App Request step calls a connected application — an EMR, a payer API, a storage
provider — using an app instance you have already configured. It is the most common way an
integration talks to an outside system.

Configuration

FieldNotes
App InstanceThe configured, credentialed connection to use. Set these up under Connectors before building the step.
ResourceThe object being acted on, such as Patient or Appointment.
ActionThe operation on that resource — for example a search or a create. The resource and action pair determines what the request looks like.
ParametersValues sent with the request. Each takes a Parameter name and a Value, with a Value Type controlling how the value is supplied — a literal, a variable, or the output of an earlier step.
Request BodyFor actions that send a body. Supply it as text, or map it from an earlier step's data.

Output

The application's response becomes this step's output, available to later steps. Pair it with a
Convert step to reshape the response into the structure a downstream system
expects.

Notes

  • A failing external system is the most common cause of an integration failure. The step's
    Continue integration if this step fails and Automatically retry this step on failure
    settings are the controls for that — see Integration Builder.
  • App request activity is logged separately under App Requests in the Log Center, which is
    usually the fastest way to see the exact request and response.

Did this page help you?