HTTP Request with YAML
Tip
Learn more about:
- HTTP Request action features
- HTTP Request integrations
- HTTP Request alternatives
YAML parameters for HTTP Request
| Name | Type | Description |
|---|---|---|
action Required | String | The ID of the action. |
type Required | String | The type of the action. Should be set to HTTP. |
notification_url Required | String | The target URL. |
method_url Required | String | The desired HTTP method. Available values are GET, POST, PUT, PATCH or DELETE. |
| port | String | The port for the connection. |
| login | String | The username required to connect to the server. |
| password | String | The password required to connect to the server. |
| content | String | The content of the request. |
| headers | Header[] | The headers that will be sent with the request. |
YAML example for HTTP request
yamlactions: - action: "Send HTTP request to http://mywebserver.io" type: "HTTP" login: "api_tests_user" password: "$api_tests_password" port: "4567" notification_url: "$url" method: "POST" content: "{\r\n\t\"url\": \"${BUDDY_RUN_URL}\",\r\n\t\"html_url\": \"${BUDDY_RUN_URL}\",\r\n\t\"id\": \"${BUDDY_RUN_ID}\",\r\n\t\"start_date\": \"${BUDDY_RUN_START_DATE}\",\r\n\t\"mode\": \"${BUDDY_RUN_START_DATE}\",\r\n\t\"refresh\": \"${BUDDY_RUN_REFRESH}\",,\r\n\t\"comment\": \"${BUDDY_RUN_COMMENT}\",\r\n}" headers: - name: "User-Agent" value: "Buddy" - name: "Content-Type" value: "application/json" timeout: 120 variables: - key: "url" value: "http://mywebserver.io"
Last modified on Jul 31, 2025