Task Inputs


This documentation is intended for our legacy V1 system and may be outdated.

Components

  • Name: A short name for the task input
  • Description: A short description of the input
  • Variable Name: A case-insensitive name to use for templating the value
  • Field Type: Type of field (string, limit, offset)
  • Sample Value: Sample value of the input
  • Required: Is a value required?
  • Secure: Should this value be encrypted if saved for reuse?
  • Interceptable: Can we intercept this variable via proxy?
  • Sample Default: Should the sample value be used as the default?

Each task may declare a set of inputs to customize exactly what the task does. For example, if your task is to fetch the current weather for a given city, you may want to make the ZIP code of the city an input for users to enter.

Inputs are implemented via templating, allowing you to find and replace via string matching in the following parts of the HTTP request:

  • Path
  • Query
  • Headers
  • Body

When a task is run, first the inputs are injected into the task definition resulting in an HTTP request to the service in question.