Sentry notification

POST Parameters

NameTypeDescription
organization_slug
Required
StringThe slug of the organization the release belongs to.
integration
Required
IntegrationThe integration.
name
Required
StringThe name of the action.
trigger_time
Required
StringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
type
Required
StringThe type of the action. Should be set to SENTRY.
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.
run_only_on_first_failureBooleanDefines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.
after_action_idIntegerThe numerical ID of the action, after which this action should be added.
repositoryStringIf Sentry is integrated with repository provider, you can enter the project slug here. You can use the $BUDDY_REPO_SLUG variable as well.
variablesVariable []The list of variables defined for this action.
trigger_conditionStringDefines when the build action should be run. Can be one of ALWAYS, ON_CHANGE, ON_CHANGE_AT_PATH, VAR_IS, VAR_IS_NOT or VAR_CONTAINS or VAR_NOT_CONTAINS.

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",
"trigger_condition": "ALWAYS",
"variables": [
{
"key": "ftp_login",
"value": "userLogin123",
"description": "The name of user to FTP.",
"encrypted": false,
"settable": false
},
{
"key": "ftp_password",
"value": "secure!14ivLMxPgv7TX6c9+ITX/g==",
"description": "The password for ftp.",
"encrypted": true
}
]
"organization_slug": "buddyworks",
"organization_name": "Buddy",
"version": "${execution.to_revision.revision}",
"environment": "linux",
"release_url": "${execution.to_revision.html_url}",
"deploy_url": "${execution.html_url}",
"repository": "$BUDDY_REPO_SLUG",
"projects": [
"java",
"my_proj"
],
"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": "Sentry Action",
"type": "SENTRY",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"variables": [
{
"key": "ftp_login",
"value": "userLogin123",
"description": "The name of user to FTP.",
"encrypted": false,
"settable": false
},
{
"key": "ftp_password",
"value": "secure!14ivLMxPgv7TX6c9+ITX/g==",
"description": "The password for ftp.",
"encrypted": true
}
]
"run_only_on_first_failure": false,
"organization_slug": "buddyworks",
"organization_name": "Buddy",
"version": "${execution.to_revision.revision}",
"environment": "linux",
"release_url": "${execution.to_revision.html_url}",
"deploy_url": "${execution.html_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",
"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"
}
}