Request Recipe

A request recipe defines how to make a particular request. For a REST API, you'll typically create one request recipe per endpoint.

Fields

FieldTypeDescriptionDefault
namestringDescriptive name to use in the UIValue of key in parent
methodstringHTTP request methodRequired
urlTemplateHTTP request URLRequired
querymapping[string, Template]HTTP request query parameters{}
headersmapping[string, Template]HTTP request headers{}
bodyTemplateHTTP request bodynull

Examples

login:
  name: Login
  method: POST
  url: "{{host}}/anything/login"
  headers:
    accept: application/json
    content-type: application/json
  query:
    root_access: yes_please
  body: |
    {
      "username": "{{chains.username}}",
      "password": "{{chains.password}}"
    }