Sentry notification

POST Parameters

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to SENTRY.
organization_slug
Required
StringThe slug of the organization the release belongs to.
integration
Required
IntegrationThe integration.
version
Required
StringThe version identifier of the release.
environment
Required
StringThe environment you’re deploying to.
organization_nameStringThe name of the organization the release belongs to.
deploy_urlStringThe optional url that points to the deploy.
release_urlStringAn optional commit reference.
projectsString[]The list of project slugs that are involved in this release.
repositoryStringIf Sentry is integrated with repository provider, you can enter the project slug here. You can use the $BUDDY_REPO_SLUG variable as well.

Example

Request

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

JSON

{
  "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"
  }
}

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": "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"
  }
}

Last modified on November 16, 2022

Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat or contact support

Get Started

Sign up for free and deploy your project in less than 10 minutes.