Skip to main content

Overview

The Notifications Testing service lets you validate Notification Center configurations before you rely on them. Send a test notification through an existing connector or preset, test a connector or preset configuration before saving it, test a destination directly, validate that a template renders correctly, and check that a routing condition is valid.

The service exposes the following operations:

  • Test Connector Config and Test Existing Connector: validate a connector configuration, or send a test notification through a connector that is already saved.
  • Test Preset Config and Test Existing Preset: validate a preset configuration, or test a preset that is already saved.
  • Test Destination: send a test notification to a destination.
  • Test Template Render: validate that a notification template renders without errors.
  • Test Routing Condition Valid: validate a routing condition.

Learn more in our documentation.

Authentication and permissions

To use the Notifications Testing service API you need to create a personal or team API key. Each method requires the Notification Center permissions listed below.

MethodRequired permission
TestConnectorConfignotification-center-connectors:UpdateConfig
TestExistingConnectornotification-center-connectors:UpdateConfig
TestPresetConfignotification-center-connectors:UpdateConfig AND notification-center-presets:UpdateConfig
TestExistingPresetnotification-center-connectors:UpdateConfig AND notification-center-presets:UpdateConfig
TestDestinationnotification-center-connectors:UpdateConfig AND notification-center-presets:UpdateConfig
TestTemplateRendernotification-center-connectors:ReadConfig OR notification-center-connectors:UpdateConfig OR notification-center-presets:ReadConfig OR notification-center-presets:UpdateConfig

Common error response codes

Status CodeDescription
400 Bad RequestResponse code 400
401 UnauthorizedResponse code 401
500 Internal Server ErrorResponse code 500

Constants

OrderByDirection
Value
ORDER_BY_DIRECTION_UNSPECIFIED
ASC
DESC
ConnectorType
Value
CONNECTOR_TYPE_UNSPECIFIED
SLACK
GENERIC_HTTPS
PAGERDUTY
AWS
PresetType
Value
PRESET_TYPE_UNSPECIFIED
SYSTEM
CUSTOM
TriggerType
Value
TRIGGER_TYPE_UNSPECIFIED
MANUAL
AUTOMATIC
FailureReason
Value
FAILURE_REASON_UNSPECIFIED
INVALID_TEMPLATE
FIELD_NOT_FOUND
TEMPLATE_EXCEEDS_MAX_LENGTH
RENDERED_VALUE_EXCEEDS_MAX_LENGTH