Edit

Share via

sp_add_notification (Transact-SQL)

  • Article

Applies to: SQL Server

Sets up a notification for an alert.

Syntax

syntaxsql 
sp_add_notification [ @alert_name = ] 'alert' ,
    [ @operator_name = ] 'operator' ,
    [ @notification_method = ] notification_method
[ ; ]

Arguments

[ @alert_name = ] 'alert'

The alert for this notification. @alert_name is sysname, with no default.

[ @operator_name = ] 'operator'

The operator to be notified when the alert occurs. @operator_name is sysname, with no default.

[ @notification_method = ] notification_method

The method by which the operator is notified. @notification_method is tinyint, with no default. @notification_method can be one or more of these values combined with an OR logical operator.

Value Description
1 E-mail
2 Pager
4 net send

Return code values

0 (success) or 1 (failure).

Result set

None.

Remarks

sp_add_notification must be run from the msdb database.

SQL Server Management Studio provides an easy, graphical way to manage the entire alerting system. Using Management Studio is the recommended way to configure your alert infrastructure.

To send a notification in response to an alert, you must first configure SQL Server Agent to send mail.

If a failure occurs when sending an e-mail message or pager notification, the failure is reported in the SQL Server Agent service error log.

Permissions

You can grant EXECUTE permissions on this procedure, but these permissions might be overridden during a SQL Server upgrade.

Examples

The following example adds an e-mail notification for the specified alert (Test Alert).

Note

This example assumes that Test Alert already exists and that François Ajenstat is a valid operator name.

SQL 
USE msdb;
GO

EXEC dbo.sp_add_notification
    @alert_name = N'Test Alert',
    @operator_name = N'François Ajenstat',
    @notification_method = 1;
GO

Related content