📣

TiDB Cloud Premium is now in public preview. Unlimited growth, instant elasticity, advanced security for enterprise workloads. Try it out →

Get Started

Overview

Quick Start

Guides

Connect
Manage Resources
Data Integration
Load Data
Unload Data
Multimodal Data Analytics
Performance Tuning
Security & Reliability
Management

Troubleshooting

Tutorials

Ingest & Stream Data
Migrate Data

Reference

SQL Reference
General Reference

Support Services

ALTER NOTIFICATION INTEGRATION

Alter the settings of a named notification integration that can be used to send notifications to external messaging services.

NOTICE: this functionality works out of the box only in TiDB Cloud Lake.

Syntax

Webhook Notification

ALTER NOTIFICATION INTEGRATION [ IF NOT EXISTS ] <name> SET
    [ ENABLED = TRUE | FALSE ]
    [ WEBHOOK = ( url = <string_literal>, method = <string_literal>, authorization_header = <string_literal> ) ]
    [ COMMENT = '<string_literal>' ]

Required Parameters	Description
name	The name of the notification integration. This is a mandatory field.

Optional Parameters (Webhook)	Description
enabled	Whether the notification integration is enabled.
url	The URL of the webhook.
method	The HTTP method to use when sending the webhook. default is `GET`
authorization_header	The authorization header to use when sending the webhook.
comment	A comment to associate with the notification integration.

Examples

Webhook Notification

ALTER NOTIFICATION INTEGRATION SampleNotification SET enabled = true

This example enables the notification integration named SampleNotification.

ALTER NOTIFICATION INTEGRATION

Syntax

Webhook Notification

Examples

Webhook Notification

Was this page helpful?