Datadog Service Check

POST Parameters

You can find the list with common parameters for all Buddy actions here.

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to DATADOG_STATUS_CHECK.
host_nameStringThe Host name to associate with the event. Any tags associated with the host will also be applied to this event.
statusIntegerAn integer for the status of the check.
checkStringThe text for the message.
messageStringA description of why this status occurred.
regionStringThe Datadog region. Can be one of NA or EU. If not set, the default is NA.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1/actions

JSON

{
"name": "Datadog Status Check Action",
"type": "DATADOG_STATUS_CHECK",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"variables": [
{
"key": "datadogHost",
"value": "linux"
}
],
"host_name": "$datadogHost",
"status": 1,
"check": "Pipeline Execution",
"message": "And let me tell you all about it here!",
"region": "EU",
"integration": {
"id": 1
}
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1/actions/1",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1/action/1/edit",
"id": 1,
"name": "Datadog Status Check Action",
"type": "DATADOG_STATUS_CHECK",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"variables": [
{
"key": "datadogHost",
"value": "linux"
}
],
"host_name": "$datadogHost",
"check": "Pipeline Execution",
"status": "OK",
"message": "And let me tell you all about it here!",
"region": "EU",
"integration": {
"url": "https://api.buddy.works/workspaces/buddy/user/integrations/1",
"html_url": "https://app.buddy.works/integrations",
"id": 1
},
"pipeline": {
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1",
"id": 1,
"name": "test server",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}