Datadog notification

  • POST
  • /workspaces
  • /:domain
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /actions

Request

URL PARAMETERS
domainrequired string
The workspace domain.
pipeline_idrequired integer
The numerical ID of the desired pipeline.
project_namerequired string
The name ID of the project.
POST PARAMETERS
namerequired string
The name of the action.
typerequired string
The type of the action. Should be set to DATADOG.
integrationrequired Integration
The integration.
alert_typerequired string
The type of the alert. Can be one of SUCCESS, WARNING or ERROR.
titleoptional string
The title of the posted event.
contentoptional string
The content of the posted event.
aggregation_keyoptional 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.
hostoptional string
The Host name to associate with the event. Any tags associated with the host will also be applied to this event.
regionoptional string
The Datadog region. Can be one of US1, US3, US5, EU1, AP1, US1_FED. If not set, the default is US1.
tagsoptional string[]
The list of tags to apply to the event.

Last modified on Oct 7, 2024

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "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": "EU1",
  "tags": [
    "version:1",
    "application:web"
  ],
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  }
}'
EXAMPLE RESPONSE
{ "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": "EU1", "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" } }
STATUS
201 Created
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999