Install Self-Hosted
Get Started on Cloud
BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAML

YAML for HTTP Request

View as Markdown

Send an HTTP request to a specified URL.

YAML parameters for HTTP Request

PARAMETERS
notification_urlrequiredstring
The target URL.
typerequiredstring

Value: HTTP

actionrequiredstring
Unique identifier for the action within the pipeline.
contentstring
The content of the request.
methodstring enum
The desired HTTP method.
Allowed enum:
GET,
POST,
PUT,
PATCH,
DELETE
headersHeaderYaml[]
The headers that will be sent with the request.
portstring
The port for the connection.
loginstring
The username required to connect to the server.
passwordstring
The password required to connect to the server.
pathsstring[]
The list of paths for the request.
multipart_uploadboolean
Enables multipart upload for the request.
trigger_timestring enum
Specifies when the action should be executed.
Allowed enum:
ON_EVERY_EXECUTION,
ON_SUCCESS,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
loopstring[]
The list of variables for dynamic action execution. The action runs once for each value.
run_only_on_first_failureboolean
Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.
disabledboolean
When set to true the action is disabled. By default it is set to false.
timeoutinteger
The timeout in seconds.
ignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions.
retry_intervalinteger
Delay time between auto retries in seconds.
retry_countinteger
Number of retries if the action fails.
run_nextstring enum
Defines whether the action should run in parallel with the next one.
Allowed enum:
WAIT_ON_SUCCESS,
IN_SOFT_PARALLEL,
IN_HARD_PARALLEL
trigger_conditionsTriggerConditionYaml[]
The list of trigger conditions to meet so that the action can be triggered.
variablesVariableYaml[]
The list of variables you can use in the action.

Last modified on Jul 31, 2025

Previous pageHoneybadgerNext pageJira Build

YAML examples for HTTP Request

HTTP POST with custom headers

yaml
  - action: HTTP Request Test
    type: HTTP
    trigger_time: ON_EVERY_EXECUTION
    timeout: 300
    disabled: false
    ignore_errors: false
    retry_count: 3
    retry_interval: 5
    content: '{"key": "value", "number": 123}'
    method: POST
    login: test_user
    password: secret_password
    port: '8080'
    notification_url: https://api.example.com/webhook
    headers:
      - name: Content-Type
        value: application/json
    - name: Authorization
      value: Bearer token123
    - name: X-Custom-Header
      value: custom-value
    paths:
      - /path/to/file1.txt
      - /path/to/file2.json
      - /uploads/data.csv
    multipart_upload: true

Simple HTTP request

yaml
  - action: HTTP Request
    type: HTTP
    login: tester
    password: '!encrypted anBQwurc0uKtPia2nksQKw==.Kgi4L8R/M5CFW4NnRYs0Fg=='
    port: '81'
    notification_url: http://buddy.works
    headers:
      - name: headerKey1
        value: headerValue1
    - name: headerKey2
      value: headerValue2
    - name: headerKey3
      value: headerValue3
    paths:
      - /maxuavtjnt
    multipart_upload: true