step.request

Summary

Request specifies how to make the request - which endpoint to go to, what body to use, etc.

Fields

method

type: string
required: yes
description: The HTTP method of the request

endpoint

type: string
required: yes
description: The complete URL of the request

headers

type: mapping
required: no
description: Headers to attach to the request. Keys may repeat. If keys repeat or the values are arrays, all the values are added to the header.

body

type: string
required: no
description: A string of the body of the request

Examples

request:
  method: "GET"
  endpoint: "http://https://jsonplaceholder.typicode.com/posts/1"
  headers:
    X-APIDAUTH: "{{ env.AUTH_TOKEN }}"
    Accept: "application/json"
    Accept: "application/ld+json"
    Accept:
      - "application/json"
      - "application/ld+json"

Didn't find what you were looking for?

You can head over to our FAQ page