Start (HTTP Request)

Defines how an HTTP Request flow is triggered, including:

  • The HTTP method of the endpoint
  • The path of the endpoint
  • The request's parameters, such as its HTTP headers

Note: This component is always the first step in an HTTP Request flow.

Inputs

Method

The HTTP method of the endpoint.

The available options include:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

URL

The path of the endpoint, such as /posts or /comments.

Authentication

An auth policy to protect the endpoint from anonymous requests. If there are no configured auth policies, the only available option is Anonymous.

Input Type

Note: This option is only available if the Method is POST, PUT, or PATCH.

The type data the endpoint can receive in the body of the request.

The available options include:

  • None
  • Text
  • FormUrlEncoded
  • Json
  • File
  • Input Schema

Input Schema

Note: This option is only available if the Input Type is Json or Input Schema.

If the Input Type is Json, this field can contain a JSON Schema that defines the shape of incoming request bodies.

If the Input Type is Input Schema, this field can contain a reference to an Input Schema that defines the shape of incoming request bodies.

Accepted Content Types

Note: This option is only available if the Input Type is File.

A list of one or more content types, such as image/png. If the incoming request body is of a different content type, the request is rejected. If no content types are defined, all content types are accepted.

Accepted File Names

Note: This option is only available if the Input Type is File.

A list of one or more file names. If the file in the incoming request has a file name that's not listed here, the request is rejected. If no file names are defined, all file names are accepted.

Headers

A list of HTTP headers that the endpoint accepts.

Name

The name of the header.

Value

The value of the header.

Type

The type of data accepted by the header.

The following data types are supported:

  • Boolean
  • DateTime
  • Decimal
  • Guid
  • Integer
  • String

Required

If enabled, the header is required and requests without the header are rejected.

Query String

A list of query string parameters that the endpoint accepts.

Name

The name of the parameter.

Value

The value of the parameter.

Type

The type of data accepted by the parameter.

The following data types are supported:

  • Boolean
  • DateTime
  • Decimal
  • Guid
  • Integer
  • String

Required

If enabled, the parameter is required and requests without the parameter are rejected.

Outputs

Headers

An object that contain's the request's HTTP headers. You can also access each individual header via this object.

QueryString

An object that contain's the request's query string parameters. You can also access each individual parameter via this object.

Body

Note: This output is only available if the Method is POST, PUT, or PATCH, and the Input Type is Json or Input Schema.

The body of the request as a JSON object. You can also access each individual property of the object.

RawBody

Note: This output is only available if the Method is POST, PUT, or PATCH, and the Input Type is Json or Input Schema.

The raw, unserialized body of the request as a string.

Body (Text)

Note: This output is only available if the Input Type is Text.

The body of the request as plain text.

File

contentType

The Content-Type of the file, such as image/png.

name

The name of the file, without an extension.

fileName

The name of the file, with an extension.

content

The content of the file as a base64-encoded string.