Datadog notification
Learn more about:
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 DATADOG . |
integration Required | Integration | The integration. |
alert_type Required | String | The type of the alert. Can be one of SUCCESS , WARNING or ERROR . |
title | String | The title of the posted event. |
content | String | The content of the posted event. |
aggregation_key | String | An arbitrary string to use for aggregation, max length of 100 characters. If you specify a key, all events using that key will be grouped together in the Event Stream. |
host | String | The Host name to associate with the event. Any tags associated with the host will also be applied to this event. |
region | String | The Datadog region. Can be one of NA or EU . If not set, the default is NA . |
tags | String[] | The list of tags to apply to the event. |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1/actions
JSON
{
"name": "Datadog Action",
"type": "DATADOG",
"trigger_time": "ON_EVERY_EXECUTION",
"alert_type": "warning",
"variables": [
{
"key": "aggregationKey",
"value": "someValue"
}
],
"aggregation_key": "$aggregationKey",
"host": "linux",
"content": "And let me tell you all about it here!.",
"title": "Something big happened!",
"region": "EU",
"tags": [
"version:1",
"application:web"
],
"integration": {
"hash_id": "5ddb7c180fb38be67bd78a88a"
}
}
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 Action",
"type": "DATADOG",
"trigger_time": "ON_EVERY_EXECUTION",
"alert_type": "warning",
"aggregation_key": "$aggregationKey",
"variables": [
{
"key": "aggregationKey",
"value": "someValue"
}
],
"host": "linux",
"content": "And let me tell you all about it here!.",
"title": "Something big happened!",
"region": "EU",
"tags": [
"version:1",
"application:web"
],
"integration": {
"url": "https://api.buddy.works/workspaces/buddy/user/integrations/1",
"html_url": "https://app.buddy.works/integrations",
"hash_id": "5ddb7c180fb38be67bd78a88a"
},
"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",
"on": "CLICK",
"refs": [
"refs/heads/master"
],
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}
Last modified on April 6, 2023