Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-142201861.5 MB
Spike Protection

Create a Spike Protection Notification Action

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.

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

Path parameters

organization_id_or_slugstring required

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

Request body

trigger_typestring required

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

service_typestring required

Service that is used for sending the notification.

  • email
  • slack
  • sentry_notification
  • pagerduty
  • opsgenie
integration_idinteger

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_identifierstring

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

Required if service_type is slack or opsgenie.

target_displaystring

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

Required if service_type is slack or opsgenie.

projectsstring[]

List of project IDs or slugs that the Notification Action is created for.

Response

idinteger required
organizationIdinteger required
integrationIdinteger nullable required
sentryAppIdinteger nullable required
projectsinteger[] required
serviceTypestring nullable required
triggerTypestring required
targetTypestring nullable required
targetIdentifierstring nullable required
targetDisplaystring nullable required