HTTP actions

preview

We're still working on this feature, but we'd love for you to try it out!

This feature is currently provided as part of a preview program pursuant to our pre-release policies.

This page provides a comprehensive reference for HTTP actions available in the workflow automation actions catalog. These actions enable you to make HTTP requests (GET, POST, PUT, DELETE) to external APIs and services as part of your workflow definitions.

Prerequisites

Before using HTTP actions in workflow automation, ensure you have:

Target API endpoint URLs.
Any required authentication credentials (API keys, tokens, etc.).
Understanding of the API request/response formats.

팁

HTTP actions support secret syntax for any header value, allowing you to securely pass sensitive data like API keys. See secrets management for more information.

Perform an HTTP GET call to retrieve data from an API endpoint.

팁

This supports secret syntax for any header value.

Input Field	Optionality	Type	Description
url	Required	String	The target URL for the request. The scheme must be included: `https://example.com`
urlParams	Optional	Map	The query parameters to append to the URL. Takes a stringified JSON object.
headers	Optional	Map	The headers to add to the request. Takes a stringified JSON object.
selectors	Optional	List	The selectors to get only the specified parameters as output.

Output Field	Type	Description
responseBody	String	The body of the response.
statusCode	Integer	The HTTP status code of the response.

Workflow example
`name: httpGetTest description: 'Performs an HTTP GET request to retrieve data' workflowInputs: url: type: String urlParams: type: String headers: type: String steps: - name: query type: action action: http.get version: '1' inputs: url: ${{ .workflowInputs.url }} urlParams: ${{ .workflowInputs.urlParams }} headers: ${{ .workflowInputs.headers }} next: end` Example inputs: `{ "url": "https://example.com", "urlParams": "{\"foo\": \"bar\"}", "headers": "{\"baz\": \"bat\"}" }` Example outputs: `{ "responseBody": "<!doctype html>\n<html>...</html>\n", "statusCode": 200 }`

Workflow example

name: httpGetTest
description: 'Performs an HTTP GET request to retrieve data'
workflowInputs:
  url:
    type: String
  urlParams:
    type: String
  headers:
    type: String
steps:
  - name: query
    type: action
    action: http.get
    version: '1'
    inputs:
      url: ${{ .workflowInputs.url }}
      urlParams: ${{ .workflowInputs.urlParams }}
      headers: ${{ .workflowInputs.headers }}
    next: end

Example inputs:

{
  "url": "https://example.com",
  "urlParams": "{\"foo\": \"bar\"}",
  "headers": "{\"baz\": \"bat\"}"
}

Example outputs:

{
  "responseBody": "<!doctype html>\n<html>...</html>\n",
  "statusCode": 200
}

Performs an HTTP POST call to send data to an API endpoint.

팁

This supports secret syntax for any header value.

Input Field	Optionality	Type	Description
url	Required	String	The target URL for the request. The scheme must be included: `https://example.com`
urlParams	Optional	Map	The query parameters to append to the URL. Takes a stringified JSON object.
headers	Optional	Map	The headers to add to the request. Takes a stringified JSON object.
body	Optional	String	The request body.
selectors	Optional	List	The selectors to get only the specified parameters as output.

Output Field	Type	Description
responseBody	String	The body of the response.
statusCode	Integer	The HTTP status code of the response.

Workflow example
`name: httpPostTest description: 'Performs an HTTP POST request to send data' workflowInputs: url: type: String urlParams: type: String headers: type: String body: type: String steps: - name: query type: action action: http.post version: '1' inputs: url: ${{ .workflowInputs.url }} urlParams: ${{ .workflowInputs.urlParams }} headers: ${{ .workflowInputs.headers }} body: ${{ .workflowInputs.body }} next: end` Example inputs: `{ "url": "https://example.com", "headers": "{\"Content-Type\":\"application/json\"}", "urlParams": "{\"foo\": \"bar\"}", "body": "{\"foo\": \"bar\"}" }` Example outputs: `{ "responseBody": "", "statusCode": 200 }`

Workflow example

name: httpPostTest
description: 'Performs an HTTP POST request to send data'
workflowInputs:
  url:
    type: String
  urlParams:
    type: String
  headers:
    type: String
  body:
    type: String
steps:
  - name: query
    type: action
    action: http.post
    version: '1'
    inputs:
      url: ${{ .workflowInputs.url }}
      urlParams: ${{ .workflowInputs.urlParams }}
      headers: ${{ .workflowInputs.headers }}
      body: ${{ .workflowInputs.body }}
    next: end

Example inputs:

{
  "url": "https://example.com",
  "headers": "{\"Content-Type\":\"application/json\"}",
  "urlParams": "{\"foo\": \"bar\"}",
  "body": "{\"foo\": \"bar\"}"
}

Example outputs:

{
  "responseBody": "",
  "statusCode": 200
}

Performs an HTTP PUT request to update data at an API endpoint.

팁

If you need to pass sensitive data to an input, for example an Api-Key header, you can use values stored via the secretsManagementCreateSecret NerdGraph mutation.

Example:

{
  "headers": "{\"Api-Key\": \"${{ :secrets:NR_API_KEY }}\"}"
}

Input Field	Optionality	Type	Description
url	Required	String	The target URL for the request. The URL must include the scheme (for example, https:// or http://). Example: `https://example.com`
urlParams	Optional	Map	The query parameters to append to the URL. Takes a stringified JSON object.
headers	Optional	Map	The headers to add to the request. Takes a stringified JSON object.
body	Optional	String	The request body.
selectors	Optional	List	The selectors to get only the specified parameters as output.

Output Field	Type	Description
responseBody	String	The body of the response.
statusCode	Integer	The HTTP status code of the response.

Workflow example
`name: httpPutTest description: 'Performs an HTTP PUT request to update data' workflowInputs: url: type: String urlParams: type: String headers: type: String body: type: String selectors: type: String steps: - name: query type: action action: http.put version: '1' inputs: url: ${{ .workflowInputs.url }} urlParams: ${{ .workflowInputs.urlParams }} headers: ${{ .workflowInputs.headers }} body: ${{ .workflowInputs.body }} selectors: ${{ .workflowInputs.selectors }} next: end` Example inputs: `{ "url": "https://example.com", "headers": "{\"Content-Type\":\"application/json\"}", "urlParams": "{\"foo\": \"bar\"}", "body": "{\"foo\": \"bar\"}", "selectors": "[{\"name\": \"responseBody\", \"expression\": \".responseBody\"}, {\"name\": \"statusCode\", \"expression\": \".statusCode\"}]" }` Example outputs: `{ "responseBody": "", "statusCode": 200 }`

Workflow example

name: httpPutTest
description: 'Performs an HTTP PUT request to update data'
workflowInputs:
  url:
    type: String
  urlParams:
    type: String
  headers:
    type: String
  body:
    type: String
  selectors:
    type: String
steps:
  - name: query
    type: action
    action: http.put
    version: '1'
    inputs:
      url: ${{ .workflowInputs.url }}
      urlParams: ${{ .workflowInputs.urlParams }}
      headers: ${{ .workflowInputs.headers }}
      body: ${{ .workflowInputs.body }}
      selectors: ${{ .workflowInputs.selectors }}
    next: end

Example inputs:

{
  "url": "https://example.com",
  "headers": "{\"Content-Type\":\"application/json\"}",
  "urlParams": "{\"foo\": \"bar\"}",
  "body": "{\"foo\": \"bar\"}",
  "selectors": "[{\"name\": \"responseBody\", \"expression\": \".responseBody\"}, {\"name\": \"statusCode\", \"expression\": \".statusCode\"}]"
}

Example outputs:

{
  "responseBody": "",
  "statusCode": 200
}

Performs an HTTP DELETE request to remove data at an API endpoint.

팁

If you need to pass sensitive data to an input, for example an Api-Key header, you can use values stored via the secretsManagementCreateSecret NerdGraph mutation.

Example:

{
  "headers": "{\"Api-Key\": \"${{ :secrets:NR_API_KEY }}\"}"
}

Input Field	Optionality	Type	Description
url	Required	String	The target URL for the request. The URL must include the scheme (for example, https:// or http://). Example: `https://example.com`
urlParams	Optional	Map	The query parameters to append to the URL. Takes a stringified JSON object.
headers	Optional	Map	The headers to add to the request. Takes a stringified JSON object.
selectors	Optional	List	The selectors to get only the specified parameters as output.

Output Field	Type	Description
responseBody	String	The body of the response.
statusCode	Integer	The HTTP status code of the response.

Workflow example
`name: httpDeleteTest description: 'Performs an HTTP DELETE request to remove data' workflowInputs: url: type: String urlParams: type: String headers: type: String selectors: type: String steps: - name: query type: action action: http.delete version: '1' inputs: url: ${{ .workflowInputs.url }} urlParams: ${{ .workflowInputs.urlParams }} headers: ${{ .workflowInputs.headers }} selectors: ${{ .workflowInputs.selectors }} next: end` Example inputs: `{ "url": "https://example.com", "urlParams": "{\"foo\": \"bar\"}", "headers": "{\"baz\": \"bat\"}", "selectors": "[{\"name\": \"responseBody\", \"expression\": \".responseBody\"}, {\"name\": \"statusCode\", \"expression\": \".statusCode\"}]" }` Example outputs: `{ "responseBody": "<!doctype html>\n<html>...</html>\n", "statusCode": 200 }`

Workflow example

name: httpDeleteTest
description: 'Performs an HTTP DELETE request to remove data'
workflowInputs:
  url:
    type: String
  urlParams:
    type: String
  headers:
    type: String
  selectors:
    type: String
steps:
  - name: query
    type: action
    action: http.delete
    version: '1'
    inputs:
      url: ${{ .workflowInputs.url }}
      urlParams: ${{ .workflowInputs.urlParams }}
      headers: ${{ .workflowInputs.headers }}
      selectors: ${{ .workflowInputs.selectors }}
    next: end

Example inputs:

{
  "url": "https://example.com",
  "urlParams": "{\"foo\": \"bar\"}",
  "headers": "{\"baz\": \"bat\"}",
  "selectors": "[{\"name\": \"responseBody\", \"expression\": \".responseBody\"}, {\"name\": \"statusCode\", \"expression\": \".statusCode\"}]"
}

Example outputs:

{
  "responseBody": "<!doctype html>\n<html>...</html>\n",
  "statusCode": 200
}

HTTP actions

preview

Prerequisites.css-21sua1{background:none;border:none;width:0;padding:0;}

팁

HTTP actions

POST request

PUT request

DELETE request

Prerequisites