Call API
The call API stage allows you to make REST API calls to any 3rd party service.
Field | Description |
URI Base | The base path of the endpoint |
URI Path | The URI path of the endpoint |
Method | The HTTP Method to use in the call (POST, GET etc) |
Payload | The request body parameter |
Header Key | The key of any additional HTTP headers to add. You can set several key/value header variables |
Header Value | The value of the key set above. |
Output variable | The name of the variable to store the response from the API in |
Once you make an HTTP call the response will be automatically stored in the output variable. If the response is detected as a JSON object then it will also store it in an object so that data elements within the response can be accessed.
For example, if the output variable is called "response" and the JSON object has a field called "name" then you can access the field in other stages by referencing "response.name"
Route Through Fixed IP
If the API you're calling requires calls to come from a white listed set of IPs then you could use this setting to make sure API calls always come from a fixed set of IPs. At this point, the following IPs should be whitelisted:
174.138.100.69
138.68.114.179