Create a Spike Protection Notification Action

POST /api/0/organizations/{organization_id_or_slug}/notifications/actions/

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.

Path Parameters

organization_id_or_slug (string)
REQUIRED

The ID or slug of the organization the resource belongs to.

Body Parameters

trigger_type (string)
REQUIRED

Type of the trigger that causes the notification. The only supported trigger right now is: spike-protection.

service_type (string)
REQUIRED

Service that is used for sending the notification.

  • email
  • slack
  • sentry_notification
  • pagerduty
  • opsgenie
integration_id (integer)

ID of the integration used as the notification service. See List Integrations to retrieve a full list of integrations.

Required if service_type is slack, pagerduty or opsgenie.

target_identifier (string)

ID of the notification target, like a Slack channel ID.

Required if service_type is slack or opsgenie.

target_display (string)

Name of the notification target, like a Slack channel name.

Required if service_type is slack or opsgenie.

projects (array(string))

List of projects slugs that the Notification Action is created for.

Scopes

<auth_token> requires one of the following scopes:
  • org:admin
  • org:read
  • org:write
curl https://sentry.io/api/0/organizations/{organization_id_or_slug}/notifications/actions/ \
 -H 'Authorization: Bearer <auth_token>' \
 -H 'Content-Type: application/json' \
 -d '{}'
RESPONSESCHEMA
{
  "id": "836501735",
  "organizationId": "62848264",
  "serviceType": "sentry_notification",
  "targetDisplay": "default",
  "targetIdentifier": "default",
  "targetType": "specific",
  "triggerType": "spike-protection",
  "projects": [
    4505321021243392
  ]
}