Sentry

Learn how to use Sentry with Composio

Overview

Enum

SENTRY

Description

Integrate Sentry to manage your error tracking and monitoring.

Authentication Details

token
stringRequired
base_url
stringDefaults to https://sentry.io

Actions

Return details on an individual project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Add or invite a member to an organization.

Action Parameters

email
stringRequired
orgRole
stringDefaults to member
organization_id_or_slug
stringRequired
reinvite
boolean
sendInvite
booleanDefaults to True
teamRoles
array

Action Response

data
object
error
successful
boolean

Add a secondary email address to account

Action Parameters

email
stringRequired
user_id
stringRequired

Action Response

data
object
error
successful
boolean

Add an organization member to a team.

Action Parameters

member_id
stringRequired
organization_id_or_slug
stringRequired
team_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Give a team access to a project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
team_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Create a new dashboard for the given organization

Action Parameters

end
string
environment
array
filters
object
id
string
organization_id_or_slug
stringRequired
period
string
projects
array
start
string
title
stringRequired
utc
boolean
widgets
array

Action Response

data
object
error
successful
boolean

Link a user from an external provider to a sentry user.

Action Parameters

external_id
string
external_name
stringRequired
id
integerRequired
integration_id
integerRequired
organization_id_or_slug
stringRequired
provider
stringRequired
user_id
integerRequired

Action Response

data
object
error
successful
boolean

Create a new metric alert rule for the given organization. a metric alert rule defines conditions for triggering alerts based on metrics like error count, latency, or failure rate. it specifies the metric type, function, time interval, and thresholds that determine when to trigger alerts. this helps proactively identify and address issues in your project.

Action Parameters

activationCondition
integer
aggregate
stringRequired
comparisonDelta
integer
dataset
string
environment
string
eventTypes
array
monitorType
integer
name
stringRequired
organization_id_or_slug
stringRequired
owner
string
projects
arrayRequired
query
stringRequired
queryType
integer
resolveThreshold
integer
thresholdType
integerRequired
timeWindow
integerRequired
triggers
arrayRequired

Action Response

data
object
error
successful
boolean

Create a new monitor.

Action Parameters

is_muted
boolean
name
stringRequired
organization_id_or_slug
stringRequired
owner
string
slug
string
status
stringDefaults to active
type
stringRequired

Action Response

data
object
error
successful
boolean

Create a new team bound to an organization. requires at least one of the name or slug body params to be set.

Action Parameters

name
string
organization_id_or_slug
stringRequired
slug
string

Action Response

data
object
error
successful
boolean

Create a new client key bound to a project. the key’s secret and public key are generated by the server.

Action Parameters

name
string
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
rateLimit__count
integer
rateLimit__window
integer

Action Response

data
object
error
successful
boolean

Create a new issue alert rule for the given project. an issue alert rule triggers whenever a new event is received for any issue in a project that matches the specified alert conditions. these conditions can include a resolved issue re-appearing or an issue affecting many users. alert conditions have three parts: - triggers: specify what type of activity you’d like monitored or when an alert should be triggered. - filters: help control noise by triggering an alert only if the issue matches the specified criteria. - actions: specify what should happen when the trigger conditions are met and the filters match.

Action Parameters

actionMatch
stringRequired
actions
arrayRequired
conditions
arrayRequired
environment
string
filterMatch
string
filters
array
frequency
integerRequired
name
stringRequired
organization_id_or_slug
stringRequired
owner
string
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Register a new service hook on a project. events include: - event.alert: an alert is generated for an event (via rules). - event.created: a new event has been processed. this endpoint requires the ‘servicehooks’ feature to be enabled for your project.

Action Parameters

events
arrayRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
url
stringRequired

Action Response

data
object
error
successful
boolean

Create a deploy.

Action Parameters

dateFinished
string
dateStarted
string
environment
stringRequired
name
string
organization_id_or_slug
stringRequired
projects
array
url
string
version
stringRequired

Action Response

data
object
error
successful
boolean

Create a new release for the given organization. releases are used by sentry to improve its error reporting abilities by correlating first seen events with the release that might have introduced the problem. releases are also necessary for source maps and other debug features that require manual upload for functioning well.

Action Parameters

commits
array
dateReleased
string
organization_id_or_slug
stringRequired
projects
arrayRequired
ref
string
refs
array
url
string
version
stringRequired

Action Response

data
object
error
successful
boolean

Create a new team bound to an organization via a scim groups post request. the slug will have a normalization of uppercases/spaces to lowercases and dashes. note that teams are always created with an empty member set.

Action Parameters

displayName
stringRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Create a new project bound to a team.

Action Parameters

default_rules
boolean
name
stringRequired
organization_id_or_slug
stringRequired
platform
string
slug
string
team_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Create a new organization member via a scim users post request. note that this api does not support setting secondary emails.

Action Parameters

organization_id_or_slug
stringRequired
sentryOrgRole
string
userName
stringRequired

Action Response

data
object
error
successful
boolean

Delete a debug information file for a given project.

Action Parameters

id
stringRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Delete an external issue.

Action Parameters

external_issue_id
stringRequired
uuid
stringRequired

Action Response

data
object
error
successful
boolean

Delete the link between a team from an external provider and a sentry team.

Action Parameters

external_team_id
integerRequired
organization_id_or_slug
stringRequired
team_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Delete the link between a user from an external provider and a sentry user.

Action Parameters

external_user_id
integerRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Delete an organization member from a team.

Action Parameters

member_id
stringRequired
organization_id_or_slug
stringRequired
team_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Delete a specific metric alert rule. a metric alert rule is a configuration that defines the conditions for triggering an alert. it specifies the metric type, function, time interval, and threshold values that determine when an alert should be triggered. metric alert rules are used to monitor and notify you when certain metrics, like error count, latency, or failure rate, cross a predefined threshold. these rules help you proactively identify and address issues in your project.

Action Parameters

alert_rule_id
integerRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Delete an organization’s custom dashboard, or tombstone a pre-built dashboard which effectively deletes it.

Action Parameters

dashboard_id
integerRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Delete a saved query.

Action Parameters

organization_id_or_slug
stringRequired
query_id
integerRequired

Action Response

data
object
error
successful
boolean

Organizationintegrationbaseendpoints expect both integration and organizationintegration db entries to exist for a given organization and integration id.

Action Parameters

integration_id
stringRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Removes an individual issue.

Action Parameters

issue_id
stringRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Remove an organization member.

Action Parameters

member_id
stringRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Delete a monitor or monitor environments.

Action Parameters

environment
array
monitor_id_or_slug
stringRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Permanently remove a release and all of its files.

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
error
successful
boolean

Deletes a spike protection notification action. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs.

Action Parameters

action_id
integerRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Schedules a project for deletion. deletion happens asynchronously and therefore is not immediate. however once deletion has begun the state of a project changes and will be hidden from most public views.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Remove a service hook.

Action Parameters

hook_id
stringRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Permanently remove the given issues. the list of issues to modify is given through the id query parameter. it is repeated for each issue that should be removed. only queries by ‘id’ are accepted. if any ids are out of scope this operation will succeed without any data mutation.

Action Parameters

id
integer
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Delete a client key for a given project.

Action Parameters

key_id
stringRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Delete a monitor or monitor environments.

Action Parameters

environment
array
monitor_id_or_slug
stringRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Delete a replay.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
replay_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete a specific issue alert rule.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
rule_id
integerRequired

Action Response

data
object
error
successful
boolean

Delete a custom symbol source from a project.

Action Parameters

id
stringRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Revoke a team’s access to a project. note that team admins can only revoke access to teams they are admins of.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
team_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Delete a file for a given release.

Action Parameters

file_id
stringRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
error
successful
boolean

Delete a file for a given release.

Action Parameters

file_id
stringRequired
organization_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
error
successful
boolean

Schedules a team for deletion. note: deletion happens asynchronously and therefore is not immediate. teams will have their slug released while waiting for deletion.

Action Parameters

organization_id_or_slug
stringRequired
team_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Delete a team with a scim group delete request.

Action Parameters

organization_id_or_slug
stringRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean

Removes an email associated with the user account

Action Parameters

user_id
stringRequired

Action Response

data
object
error
successful
boolean

Delete an organization member with a scim user delete request.

Action Parameters

member_id
stringRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Retrieves the details of an issue event.

Action Parameters

environment
array
event_id
stringRequired
issue_id
integerRequired

Action Response

data
object
error
successful
boolean

Return a list of active metric alert rules bound to an organization. a metric alert rule is a configuration that defines the conditions for triggering an alert. it specifies the metric type, function, time interval, and threshold values that determine when an alert should be triggered. metric alert rules are used to monitor and notify you when certain metrics, like error count, latency, or failure rate, cross a predefined threshold. these rules help you proactively identify and address issues in your project.

Action Parameters

organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

[warning]: this api is an experimental alpha feature and is subject to change! list all derived statuses of releases that fall within the provided start/end datetimes. constructs a response key’d off {release_version}-{project_slug} that lists thresholds with their status for specified projects. each returned enriched threshold will contain the full serialized release threshold instance as well as it’s derived health statuses.

Action Parameters

end
stringRequired
environment
array
organization_id_or_slug
stringRequired
projectSlug
array
release
array
start
stringRequired

Action Response

data
object
error
successful
boolean

Return a count of replays for the given issue or transaction id.

Action Parameters

end
string
environment
array
organization_id_or_slug
stringRequired
project
array
query
string
start
string
statsPeriod
string

Action Response

data
object
error
successful
boolean

Return details on an individual replay.

Action Parameters

cursor
string
end
string
environment
string
field
array
organization_id_or_slug
stringRequired
per_page
integer
project
array
query
string
replay_id
stringRequired
sort
string
start
string
statsPeriod
string

Action Response

data
object
error
successful
boolean

Return a list of selectors for a given organization.

Action Parameters

cursor
string
end
string
environment
array
organization_id_or_slug
stringRequired
per_page
integer
project
array
query
string
sort
string
start
string
statsPeriod
string

Action Response

data
object
error
successful
boolean

Return details on a project environment.

Action Parameters

environment
stringRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Returns details on a project’s ownership configuration.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of files for a given release.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
error
successful
boolean

Retrieve a collection of rrweb dom node-ids and the timestamp they were clicked.

Action Parameters

cursor
string
environment
array
organization_id_or_slug
stringRequired
per_page
integer
project_id_or_slug
stringRequired
query
string
replay_id
stringRequired

Action Response

data
object
error
successful
boolean

Return a replay recording segment.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
replay_id
stringRequired
segment_id
integerRequired

Action Response

data
object
error
successful
boolean

Returns a list of values associated with this key for an issue. returns at most 1000 values when paginated.

Action Parameters

environment
array
issue_id
integerRequired
key
stringRequired
sort
string

Action Response

data
object
error
successful
boolean

Return a list of activations for a metric alert rule. an activation represents a single instance of an activated alert rule being triggered. it contains a date added field which represents the time the alert was triggered. activations can be filtered by start and end parameters to return activations with date added that falls within the specified time window.

Action Parameters

alert_rule_id
integerRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Organizationintegrationbaseendpoints expect both integration and organizationintegration db entries to exist for a given organization and integration id.

Action Parameters

integration_id
stringRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return details on an individual organization, including various details such as membership access and teams.

Action Parameters

detailed
string
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of organizations available to the authenticated session in a region. this is particularly useful for requests with a user bound context. for api key-based requests this will only return the organization that belongs to the key.

Action Parameters

cursor
string
owner
boolean
query
string
sortBy
string

Action Response

data
object
error
successful
boolean

Lists an organization’s environments.

Action Parameters

organization_id_or_slug
stringRequired
visibility
string

Action Response

data
object
error
successful
boolean

Return details on an individual issue. this returns the basic stats for the issue (title, last seen, first seen), some overall numbers (number of comments, user reports) as well as the summarized event data.

Action Parameters

issue_id
stringRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Retrieves details for a monitor.

Action Parameters

environment
array
monitor_id_or_slug
stringRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return details on an individual release.

Action Parameters

adoptionStages
boolean
health
boolean
healthStatsPeriod
string
organization_id_or_slug
stringRequired
project_id
string
query
string
sort
string
status
string
summaryStatsPeriod
string
version
stringRequired

Action Response

data
object
error
successful
boolean

Returns a time series of release health session statistics for projects bound to an organization. the interval and date range are subject to certain restrictions and rounding rules. the date range is rounded to align with the interval, and is rounded to at least one hour. the interval can at most be one day and at least one hour currently. it has to cleanly divide one day, for rounding reasons. because of technical limitations, this endpoint returns at most 10000 data points. for example, if you select a 90 day window grouped by releases, you will see at most floor(10k / (90 + 1)) = 109 releases. to get more results, reduce the statsperiod.

Action Parameters

end
string
environment
array
field
arrayRequired
groupBy
array
includeSeries
integer
includeTotals
integer
interval
string
orderBy
string
organization_id_or_slug
stringRequired
per_page
integer
project
array
query
string
start
string
statsPeriod
string

Action Response

data
object
error
successful
boolean

Query summarized event counts by project for your organization. also see https://docs.sentry.io/api/organizations/retrieve-event-counts-for-an-organization-v2/ for reference.

Action Parameters

category
string
download
boolean
end
string
field
stringRequired
interval
string
organization_id_or_slug
stringRequired
outcome
string
project
array
reason
string
start
string
statsPeriod
string

Action Response

data
object
error
successful
boolean

Return a list of events bound to a project.

Action Parameters

cursor
string
full
boolean
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
sample
boolean

Action Response

data
object
error
successful
boolean

Return a set of points representing a normalized timestamp and the number of events seen in the period. query ranges are limited to sentry’s configured time-series resolutions.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
resolution
string
since
string
stat
string
until
string

Action Response

data
object
error
successful
boolean

Return a service hook bound to a project.

Action Parameters

hook_id
stringRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of projects available to the authenticated session.

Action Parameters

cursor
string

Action Response

data
object
error
successful
boolean

Retrieves details for a monitor.

Action Parameters

monitor_id_or_slug
stringRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return details on an individual issue alert rule. an issue alert rule triggers whenever a new event is received for any issue in a project that matches the specified alert conditions. these conditions can include a resolved issue re-appearing or an issue affecting many users. alert conditions have three parts: - triggers - specify what type of activity you’d like monitored or when an alert should be triggered. - filters - help control noise by triggering an alert only if the issue matches the specified criteria. - actions - specify what should happen when the trigger conditions are met and the filters match.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
rule_id
integerRequired

Action Response

data
object
error
successful
boolean

Query an individual team with a scim group get request. - note that the members field will only contain up to 10000 members.

Action Parameters

organization_id_or_slug
stringRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean

Return a list of integration platform installations for a given organization.

Action Parameters

organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

List all members on a team. the response will not include members with pending invites.

Action Parameters

cursor
string
organization_id_or_slug
stringRequired
team_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of users who have viewed a replay.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
replay_id
stringRequired

Action Response

data
object
error
successful
boolean

Retrieve a list of custom dashboards that are associated with the given organization.

Action Parameters

cursor
string
organization_id_or_slug
stringRequired
per_page
integer

Action Response

data
object
error
successful
boolean

List all organization members. response includes pending invites that are approved by organization owners or managers but waiting to be accepted by the invitee.

Action Parameters

organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of releases for a given organization.

Action Parameters

organization_id_or_slug
stringRequired
query
string

Action Response

data
object
error
successful
boolean

Return a list of version control repositories for a given organization.

Action Parameters

organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Returns a list of teams the user has access to in the specified organization. note that this endpoint is restricted to user auth tokens.

Action Parameters

organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of users seen within this project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
query
string

Action Response

data
object
error
successful
boolean

Returns a paginated list of members bound to a organization with a scim users get request.

Action Parameters

count
integerDefaults to 100
excludedAttributes
array
filter
string
organization_id_or_slug
stringRequired
startIndex
integerDefaults to 1

Action Response

data
object
error
successful
boolean

Returns a list of teams bound to a organization.

Action Parameters

cursor
string
detailed
string
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Link a team from an external provider to a sentry team.

Action Parameters

external_id
string
external_name
stringRequired
integration_id
integerRequired
organization_id_or_slug
stringRequired
provider
stringRequired
team_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Update a monitor.

Action Parameters

is_muted
boolean
monitor_id_or_slug
stringRequired
name
stringRequired
organization_id_or_slug
stringRequired
owner
string
slug
string
status
stringDefaults to active
type
stringRequired

Action Response

data
object
error
successful
boolean

Updates a spike protection notification action. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs.

Action Parameters

action_id
integerRequired
integration_id
integer
organization_id_or_slug
stringRequired
projects
array
service_type
stringRequired
target_display
string
target_identifier
string
trigger_type
stringRequired

Action Response

data
object
error
successful
boolean

Update various attributes and configurable settings for the given organization.

Action Parameters

alertsMemberWrite
boolean
allowJoinRequests
boolean
allowSharedIssues
boolean
attachmentsRole
string
avatar
string
avatarType
string
cancelDeletion
boolean
codecovAccess
boolean
dataScrubber
boolean
dataScrubberDefaults
boolean
debugFilesRole
string
defaultRole
string
enhancedPrivacy
boolean
eventsMemberAdmin
boolean
githubNudgeInvite
boolean
githubOpenPRBot
boolean
githubPRBot
boolean
hideAiFeatures
boolean
isEarlyAdopter
boolean
issueAlertsThreadFlag
boolean
metricAlertsThreadFlag
boolean
name
string
openMembership
boolean
organization_id_or_slug
stringRequired
relayPiiConfig
string
require2FA
boolean
safeFields
array
scrapeJavaScript
boolean
scrubIPAddresses
boolean
sensitiveFields
array
slug
string
storeCrashReports
integer
trustedRelays
array

Action Response

data
object
error
successful
boolean

Update an organization release file.

Action Parameters

dist
string
file_id
stringRequired
name
string
organization_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
error
successful
boolean

Update a team’s attributes with a scim group patch request.

Action Parameters

Operations
arrayRequired
organization_id_or_slug
stringRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean

Update an organization member’s attributes with a scim patch request.

Action Parameters

Operations
arrayRequired
member_id
stringRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Add a custom symbol source to a project.

Action Parameters

access_key
string
bucket
string
client_email
string
id
string
layout__casing
string
layout__type
string
name
stringRequired
organization_id_or_slug
stringRequired
password
string
prefix
string
private_key
string
project_id_or_slug
stringRequired
region
string
secret_key
string
type
stringRequired
url
string
username
string

Action Response

data
object
error
successful
boolean

Enables spike protection feature for some of the projects within the organization.

Action Parameters

organization_id_or_slug
stringRequired
projects
arrayRequired

Action Response

data
object
error
successful
boolean

Return details on an individual metric alert rule. a metric alert rule is a configuration that defines the conditions for triggering an alert. it specifies the metric type, function, time interval, and threshold values that determine when an alert should be triggered. metric alert rules are used to monitor and notify you when certain metrics, like error count, latency, or failure rate, cross a predefined threshold. these rules help you proactively identify and address issues in your project.

Action Parameters

alert_rule_id
integerRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of commits for a given repository.

Action Parameters

organization_id_or_slug
stringRequired
repo_id
stringRequired

Action Response

data
object
error
successful
boolean

Retrieve files changed in a release’s commits

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
error
successful
boolean

Retrieve a list of debug information files for a given project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

This resolves an event id to the project slug and internal issue id and internal event id.

Action Parameters

event_id
stringRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of files for a given release.

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of error events bound to an issue

Action Parameters

end
string
environment
array
full
boolean
issue_id
integerRequired
query
string
sample
boolean
start
string
statsPeriod
string

Action Response

data
object
error
successful
boolean

This endpoint lists an issue’s hashes, which are the generated checksums used to aggregate individual events.

Action Parameters

cursor
string
full
booleanDefaults to True
issue_id
stringRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of values associated with this key for an issue. when paginated can return at most 1000 values.

Action Parameters

environment
array
issue_id
integerRequired
key
stringRequired

Action Response

data
object
error
successful
boolean

Retrieve a list of check-ins for a monitor

Action Parameters

monitor_id_or_slug
stringRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Retrieve a list of check-ins for a monitor

Action Parameters

monitor_id_or_slug
stringRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Returns a serialized spike protection notification action object. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs.

Action Parameters

action_id
integerRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return details about an organization’s custom dashboard.

Action Parameters

dashboard_id
integerRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Retrieves discover (also known as events) data for a given organization.

Action Parameters

end
string
environment
array
field
arrayRequired
organization_id_or_slug
stringRequired
per_page
integer
project
array
query
string
sort
string
start
string
statsPeriod
string

Action Response

data
object
error
successful
boolean

Lists all the available integrations for an organization.

Action Parameters

features
array
includeConfig
boolean
organization_id_or_slug
stringRequired
providerKey
string

Action Response

data
object
error
successful
boolean

Retrieve an organization member’s details. response will be a pending invite if it has been approved by organization owners or managers but is waiting to be accepted by the invitee.

Action Parameters

member_id
stringRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Lists monitors, including nested monitor environments. may be filtered to a project or environment.

Action Parameters

environment
array
organization_id_or_slug
stringRequired
owner
string
project
array

Action Response

data
object
error
successful
boolean

Return a list of projects bound to a organization.

Action Parameters

cursor
string
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of trusted relays bound to an organization. if the organization doesn’t have relay usage enabled it returns a 404.

Action Parameters

organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

List an organization release’s commits.

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of replays belonging to an organization.

Action Parameters

cursor
string
end
string
environment
string
field
array
organization_id_or_slug
stringRequired
per_page
integer
project
array
query
string
sort
string
start
string
statsPeriod
string

Action Response

data
object
error
successful
boolean

Returns a paginated list of teams bound to a organization with a scim groups get request. note that the members field will only contain up to 10,000 members.

Action Parameters

count
integerDefaults to 100
excludedAttributes
array
filter
string
organization_id_or_slug
stringRequired
startIndex
integerDefaults to 1

Action Response

data
object
error
successful
boolean

Query event counts for your organization. select a field, define a date range, and group or filter by columns.

Action Parameters

category
string
end
string
field
stringRequired
groupBy
arrayRequired
interval
string
organization_id_or_slug
stringRequired
outcome
string
project
array
reason
string
start
string
statsPeriod
string

Action Response

data
object
error
successful
boolean

Get integration provider information about all available integrations for an organization.

Action Parameters

organization_id_or_slug
stringRequired
providerKey
string

Action Response

data
object
error
successful
boolean

Lists a project’s environments.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
visibility
string

Action Response

data
object
error
successful
boolean

Return details on an individual event.

Action Parameters

event_id
stringRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Retrieve a list of filters for a given project. active will be either a boolean or a list for the legacy browser filters.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of service hooks bound to a project.

Action Parameters

cursor
string
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of issues (groups) bound to a project. all parameters are supplied as query string parameters. a default query of is:unresolved is applied. to return results with other statuses send an new query value (i.e. ?query= for all results). the statsperiod parameter can be used to select the timeline stats which should be present. possible values are: "" (disable),"24h" (default), "14d" user feedback items from the user feedback widget are built off the issue platform, so to return a list of user feedback items for a specific project, filter for issue.category:feedback.

Action Parameters

cursor
string
hashes
string
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
query
string
shortIdLookup
boolean
statsPeriod
string

Action Response

data
object
error
successful
boolean

Return a list of client keys bound to a project.

Action Parameters

cursor
string
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
status
string

Action Response

data
object
error
successful
boolean

Return a client key bound to a project.

Action Parameters

key_id
stringRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Returns a list of active organization members that belong to any team assigned to the project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Retrieve a file for a given release.

Action Parameters

download
boolean
file_id
stringRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of active issue alert rules bound to a project. an issue alert rule triggers whenever a new event is received for any issue in a project that matches the specified alert conditions. these conditions can include a resolved issue re-appearing or an issue affecting many users. alert conditions have three parts: - triggers: specify what type of activity you’d like monitored or when an alert should be triggered. - filters: help control noise by triggering an alert only if the issue matches the specified criteria. - actions: specify what should happen when the trigger conditions are met and the filters match.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

List custom symbol sources configured for a project.

Action Parameters

id
string
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of values associated with this key. the query parameter can be used to to perform a “contains” match on values. when paginated can return at most 1000 values.

Action Parameters

key
stringRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of teams that have access to this project.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

List a project release’s commits.

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of deploys for a given release.

Action Parameters

organization_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
error
successful
boolean

Retrieve a file for a given release.

Action Parameters

download
boolean
file_id
stringRequired
organization_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
error
successful
boolean

Return a collection of replay recording segments.

Action Parameters

cursor
string
organization_id_or_slug
stringRequired
per_page
integer
project_id_or_slug
stringRequired
replay_id
stringRequired

Action Response

data
object
error
successful
boolean

Retrieve a list of saved queries that are associated with the given organization.

Action Parameters

cursor
string
organization_id_or_slug
stringRequired
per_page
integer
query
string
sortBy
string

Action Response

data
object
error
successful
boolean

Retrieve a saved query.

Action Parameters

organization_id_or_slug
stringRequired
query_id
integerRequired

Action Response

data
object
error
successful
boolean

This resolves a short id to the project slug and internal issue id.

Action Parameters

organization_id_or_slug
stringRequired
short_id
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of source map errors for a given event.

Action Parameters

event_id
stringRequired
exception_idx
integerRequired
frame_idx
integerRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return details on an individual team.

Action Parameters

collapse
string
expand
string
organization_id_or_slug
stringRequired
team_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of projects bound to a team.

Action Parameters

cursor
string
organization_id_or_slug
stringRequired
team_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Returns a list of emails. primary email will have isprimary: true

Action Parameters

user_id
stringRequired

Action Response

data
object
error
successful
boolean

Return a list of user feedback items within this project. this list does not include submissions from the user feedback widget. this is because it is based on an older format called user reports - read more here. to return a list of user feedback items from the widget, please use the issue api with the filter issue.category:feedback.*

Action Parameters

organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Query an individual organization member with a scim user get request. - the name object will contain fields firstname and lastname with the values of n/a. sentry’s scim api does not currently support these fields but returns them for compatibility purposes.

Action Parameters

member_id
stringRequired
organization_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Create a new saved query for the given organization.

Action Parameters

display
string
end
string
environment
array
fields
array
interval
string
name
stringRequired
orderby
string
organization_id_or_slug
stringRequired
projects
array
query
string
queryDataset
stringDefaults to error-events
range
string
start
string
topEvents
integer
yAxis
array

Action Response

data
object
error
successful
boolean

Creates a new notification action for spike protection. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs.

Action Parameters

integration_id
integer
organization_id_or_slug
stringRequired
projects
array
service_type
stringRequired
target_display
string
target_identifier
string
trigger_type
stringRequired

Action Response

data
object
error
successful
boolean

this endpoint is deprecated. we document it here for older sdks and users who are still migrating to the user feedback widget or api(multi-platform). if you are a new user, do not use this endpoint - unless you don’t have a js frontend, and your platform’s sdk does not offer a feedback api. feedback must be received by the server no more than 30 minutes after the event was saved. additionally, within 5 minutes of submitting feedback it may also be overwritten. this is useful in situations where you may need to retry sending a request due to network failures. if feedback is rejected due to a mutability threshold, a 409 status code will be returned. note: feedback may be submitted with dsn authentication (see auth documentation).

Action Parameters

comments
stringRequired
email
stringRequired
event_id
stringRequired
name
stringRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

The relevant organization member must already be a part of the team. note that for organization admins, managers, and owners, they are automatically granted a minimum team role of admin on all teams they are part of. read more about team roles.

Action Parameters

member_id
stringRequired
organization_id_or_slug
stringRequired
teamRole
stringDefaults to contributor
team_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Update various inbound data filters for a project.

Action Parameters

active
boolean
filter_id
stringRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
subfilters
array

Action Response

data
object
error
successful
boolean

Update the visibility for a project environment.

Action Parameters

environment
stringRequired
isHidden
booleanRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Update a team in an external provider that is currently linked to a sentry team.

Action Parameters

external_id
string
external_name
stringRequired
external_team_id
integerRequired
integration_id
integerRequired
organization_id_or_slug
stringRequired
provider
stringRequired
team_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Update a user in an external provider that is currently linked to a sentry user.

Action Parameters

external_id
string
external_name
stringRequired
external_user_id
integerRequired
id
integerRequired
integration_id
integerRequired
organization_id_or_slug
stringRequired
provider
stringRequired
user_id
integerRequired

Action Response

data
object
error
successful
boolean

Updates an individual issue’s attributes. only the attributes submitted are modified.

Action Parameters

assignedTo
string
hasSeen
boolean
isBookmarked
boolean
isPublic
boolean
isSubscribed
boolean
issue_id
stringRequired
organization_id_or_slug
stringRequired
status
string
statusDetails__inCommit
string
statusDetails__inNextRelease
boolean
statusDetails__inRelease
string

Action Response

data
object
error
successful
boolean

Updates a metric alert rule. see metric alert rule types under create a metric alert rule for an organization to see valid request body configurations for different types of metric alert rule types. > warning: calling this endpoint fully overwrites the specified metric alert. a metric alert rule is a configuration that defines the conditions for triggering an alert. it specifies the metric type, function, time interval, and threshold values that determine when an alert should be triggered. metric alert rules are used to monitor and notify you when certain metrics, like error count, latency, or failure rate, cross a predefined threshold. these rules help you proactively identify and address issues in your project.

Action Parameters

activationCondition
integer
aggregate
stringRequired
alert_rule_id
integerRequired
comparisonDelta
integer
dataset
string
environment
string
eventTypes
array
monitorType
integer
name
stringRequired
organization_id_or_slug
stringRequired
owner
string
projects
arrayRequired
query
stringRequired
queryType
integer
resolveThreshold
integer
thresholdType
integerRequired
timeWindow
integerRequired
triggers
arrayRequired

Action Response

data
object
error
successful
boolean

Edit an organization’s custom dashboard as well as any bulk edits on widgets that may have been made. (for example, widgets that have been rearranged, updated queries and fields, specific display types, and so on.)

Action Parameters

dashboard_id
integerRequired
end
string
environment
array
filters
object
id
string
organization_id_or_slug
stringRequired
period
string
projects
array
start
string
title
string
utc
boolean
widgets
array

Action Response

data
object
error
successful
boolean

Update a member’s organization-level and team-level roles. note that for changing organization-roles, this endpoint is restricted to user auth tokens. additionally, both the original and desired organization role must have the same or lower permissions than the role of the organization user making the request for example, an organization manager may change someone’s role from member to manager, but not to owner.

Action Parameters

member_id
stringRequired
orgRole
string
organization_id_or_slug
stringRequired
teamRoles
array

Action Response

data
object
error
successful
boolean

Update various attributes and configurable settings for the given project. note that solely having the project:read scope restricts updatable settings to isbookmarked.

Action Parameters

highlightContext
object
highlightTags
array
isBookmarked
boolean
name
string
organization_id_or_slug
stringRequired
platform
string
project_id_or_slug
stringRequired
resolveAge
integer
slug
string
subjectPrefix
string
subjectTemplate
string

Action Response

data
object
error
successful
boolean

Bulk mutate various attributes on issues. the list of issues to modify is given through the id query parameter. it is repeated for each issue that should be modified. - for non-status updates, the id query parameter is required. - for status updates, the id query parameter may be omitted for a batch “update all” query. - an optional status query parameter may be used to restrict mutations to only events with the given status. the following attributes can be modified and are supplied as json object in the body: if any ids are out of scope this operation will succeed without any data mutation.

Action Parameters

assignedTo
string
hasSeen
boolean
id
integer
ignoreDuration
integer
isBookmarked
boolean
isPublic
boolean
merge
boolean
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
status
string
statusDetails__ignoreCount
integer
statusDetails__ignoreDuration
integer
statusDetails__ignoreUserCount
integer
statusDetails__ignoreUserWindow
integer
statusDetails__ignoreWindow
integer
statusDetails__inCommit
string
statusDetails__inNextRelease
boolean
statusDetails__inRelease
string

Action Response

data
object
error
successful
boolean

Update various settings for a client key.

Action Parameters

browserSdkVersion
string
dynamicSdkLoaderOptions__hasDebug
boolean
dynamicSdkLoaderOptions__hasPerformance
boolean
dynamicSdkLoaderOptions__hasReplay
boolean
isActive
boolean
key_id
stringRequired
name
string
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
rateLimit__count
integer
rateLimit__window
integer

Action Response

data
object
error
successful
boolean

Update a monitor.

Action Parameters

is_muted
boolean
monitor_id_or_slug
stringRequired
name
stringRequired
organization_id_or_slug
stringRequired
owner
string
project_id_or_slug
stringRequired
slug
string
status
stringDefaults to active
type
stringRequired

Action Response

data
object
error
successful
boolean

Updates ownership configurations for a project. note that only the attributes submitted are modified.

Action Parameters

autoAssignment
string
codeownersAutoSync
booleanDefaults to True
fallthrough
boolean
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
raw
string

Action Response

data
object
error
successful
boolean

Update a project release file.

Action Parameters

dist
string
file_id
stringRequired
name
string
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
error
successful
boolean

Updates an issue alert rule. > warning: calling this endpoint fully overwrites the specified issue alert. an issue alert rule triggers whenever a new event is received for any issue in a project that matches the specified alert conditions. these conditions can include a resolved issue re-appearing or an issue affecting many users. alert conditions have three parts: - triggers - specify what type of activity you’d like monitored or when an alert should be triggered. - filters - help control noise by triggering an alert only if the issue matches the specified criteria. - actions - specify what should happen when the trigger conditions are met and the filters match.

Action Parameters

actionMatch
stringRequired
actions
arrayRequired
conditions
arrayRequired
environment
string
filterMatch
string
filters
array
frequency
integerRequired
name
stringRequired
organization_id_or_slug
stringRequired
owner
string
project_id_or_slug
stringRequired
rule_id
integerRequired

Action Response

data
object
error
successful
boolean

Update a release. this can change some metadata associated with the release (the ref, url, and dates).

Action Parameters

commits
array
dateReleased
string
organization_id_or_slug
stringRequired
ref
string
refs
array
url
string
version
stringRequired

Action Response

data
object
error
successful
boolean

Modify a saved query.

Action Parameters

display
string
end
string
environment
array
fields
array
interval
string
name
stringRequired
orderby
string
organization_id_or_slug
stringRequired
projects
array
query
string
queryDataset
stringDefaults to error-events
query_id
integerRequired
range
string
start
string
topEvents
integer
yAxis
array

Action Response

data
object
error
successful
boolean

Update a custom symbol source in a project.

Action Parameters

access_key
string
bucket
string
client_email
string
id
stringRequired
layout__casing
string
layout__type
string
name
stringRequired
organization_id_or_slug
stringRequired
password
string
prefix
string
private_key
string
project_id_or_slug
stringRequired
region
string
secret_key
string
type
stringRequired
url
string
username
string

Action Response

data
object
error
successful
boolean

Update various attributes and configurable settings for the given team.

Action Parameters

organization_id_or_slug
stringRequired
slug
stringRequired
team_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Update a primary email address

Action Parameters

email
stringRequired
user_id
stringRequired

Action Response

data
object
error
successful
boolean

Update a service hook.

Action Parameters

events
arrayRequired
hook_id
stringRequired
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
url
stringRequired

Action Response

data
object
error
successful
boolean

Upload a new debug information file for the given release. unlike other api requests, files must be uploaded using the traditional multipart/form-data content-type. requests to this endpoint should use the region-specific domain eg. us.sentry.io or de.sentry.io. the file uploaded is a zip archive of an apple .dsym folder which contains the individual debug images. uploading through this endpoint will create different files for the contained images.

Action Parameters

file
object
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired

Action Response

data
object
error
successful
boolean

Upload a new file for the given release. unlike other api requests, files must be uploaded using the traditional multipart/form-data content-type. requests to this endpoint should use the region-specific domain eg. us.sentry.io or de.sentry.io the optional ‘name’ attribute should reflect the absolute path that this file will be referenced as. for example, in the case of javascript you might specify the full web uri.

Action Parameters

dist
string
file
object
header
string
name
string
organization_id_or_slug
stringRequired
project_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
error
successful
boolean

Upload a new file for the given release. unlike other api requests, files must be uploaded using the traditional multipart/form-data content-type. requests to this endpoint should use the region-specific domain eg. us.sentry.io or de.sentry.io. the optional ‘name’ attribute should reflect the absolute path that this file will be referenced as. for example, in the case of javascript you might specify the full web uri.

Action Parameters

dist
string
file
object
header
string
name
string
organization_id_or_slug
stringRequired
version
stringRequired

Action Response

data
object
error
successful
boolean

Returns all spike protection notification actions for an organization. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs. you can use either the project or projectslug query parameter to filter for certain projects. note that if both are present, projectslug takes priority.

Action Parameters

organization_id_or_slug
stringRequired
project
array
project_id_or_slug
array
triggerType
string

Action Response

data
object
error
successful
boolean