📣

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

Get Started

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

CREATE NOTIFICATION INTEGRATION

Creates 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

CREATE NOTIFICATION INTEGRATION [ IF NOT EXISTS ] <name>
TYPE = <type>
ENABLED = <bool>
[ 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.
type	The type of the notification integration. Currently, only `webhook` is supported.
enabled	Whether the notification integration is enabled.

Optional Parameters (Webhook)	Description
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.

Examples

Webhook Notification

CREATE NOTIFICATION INTEGRATION IF NOT EXISTS SampleNotification type = webhook enabled = true webhook = (url = 'https://example.com', method = 'GET', authorization_header = 'bearer auth')

This example creates a notification integration named SampleNotification of type webhook that is enabled and sends notifications to the https://example.com URL using the GET method and the bearer auth authorization header.

CREATE NOTIFICATION INTEGRATION

Syntax

Webhook Notification

Examples

Webhook Notification

Was this page helpful?