HTTP Request
POST Parameters
Name | Type | Description |
---|---|---|
name Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to HTTP . |
notification_url Required | String | The target URL. |
method Required | String | The desired HTTP method. Available values are GET , POST , PUT , PATCH or DELETE . |
port | String | The port for the connection. |
content | String | The content of the request. |
headers | Header[] | The headers that will be sent with the request. |
login | String | The username required to connect to the server. |
password | String | The password required to connect to the server. |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions
JSON
{"name": "HTTP Action","type": "HTTP","trigger_time": "ON_EVERY_EXECUTION","trigger_condition": "ALWAYS","variables": [{"key": "endpointUrl","value": "http://mywebserver.io"}],"content": "Pipeline executed successfully!","notification_url": "$endpointUrl","port": "1234","method": "PATCH","timeout": 120,"headers": [{"name": "User-Agent","value": "Buddy"}]}
Sample Response
HTTP
Status: 201 CreatedX-Rate-Limit-Limit: 1X-Rate-Limit-Remaining: 999
JSON
{"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2","html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/2/edit","id": 2,"name": "HTTP Action","type": "HTTP","trigger_time": "ON_EVERY_EXECUTION","trigger_condition": "ALWAYS","variables": [{"key": "endpointUrl","value": "http://mywebserver.io"}]"last_execution_status": "INITIAL","content": "Pipeline executed successfully!","notification_url": "$endpointUrl","port": "1234","method": "PATCH","headers": [{"name": "User-Agent","value": "Buddy"}],"pipeline": {"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2","html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2","id": 2,"name": "Live mirror","trigger_mode": "MANUAL","ref_name": "master","last_execution_status": "SUCCESSFUL","last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"}}