Sentry notification

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

Hint

List with common parameters for all Buddy 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 SENTRY.

organization_slugrequired string

The slug of the organization the release belongs to.

integrationrequired Integration

The integration.

versionrequired string

The version identifier of the release.

environmentrequired string

The environment you’re deploying to.

organization_namestring

The name of the organization the release belongs to.

deploy_urlstring

The optional url that points to the deploy.

release_urlstring

An optional commit reference.

projectsstring[]

The list of project slugs that are involved in this release.

repositorystring

If Sentry is integrated with repository provider, you can enter the project slug here. You can use the $BUDDY_REPO_SLUG variable as well.

Last modified on Oct 7, 2024

Run Docker container Set variables

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": "Sentry Action",
  "type": "SENTRY",
  "trigger_time": "ON_EVERY_EXECUTION",
  "organization_slug": "buddyworks",
  "organization_name": "Buddy",
  "version": "${BUDDY_EXECUTION_REVISION}",
  "environment": "linux",
  "release_url": "${BUDDY_EXECUTION_REVISION_URL}",
  "deploy_url": "${BUDDY_EXECUTION_URL}",
  "repository": "$BUDDY_REPO_SLUG",
  "projects": [
    "java",
    "my_proj"
  ],
  "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": "Sentry Action",
  "type": "SENTRY",
  "trigger_time": "ON_EVERY_EXECUTION",
  "organization_slug": "buddyworks",
  "organization_name": "Buddy",
  "version": "${BUDDY_EXECUTION_REVISION}",
  "environment": "linux",
  "release_url": "${BUDDY_EXECUTION_REVISION_URL}",
  "deploy_url": "${BUDDY_EXECUTION_URL}",
  "repository": "$BUDDY_REPO_SLUG",
  "projects": [
    "java",
    "my_proj"
  ],
  "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