Categories:

User & Security DDL (Third-Party Service Integrations)

DESCRIBE INTEGRATION

Describes the properties of an integration.

DESCRIBE can be abbreviated to DESC.

See also:

SHOW INTEGRATIONS

API integrations

ALTER API INTEGRATION , CREATE API INTEGRATION

Notification integrations

ALTER NOTIFICATION INTEGRATION , CREATE NOTIFICATION INTEGRATION

Security integrations

ALTER SECURITY INTEGRATION , CREATE SECURITY INTEGRATION

Storage integrations

ALTER STORAGE INTEGRATION , CREATE STORAGE INTEGRATION

Syntax

DESC[RIBE] [ { API | NOTIFICATION | SECURITY | STORAGE } ] INTEGRATION <name>

Parameters

name

Specifies the identifier for the integration to describe. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.

Usage Notes

  • To post-process the output of this command, you can use the RESULT_SCAN function, which treats the output as a table that can be queried.

  • If the integration is an API integration, then the output includes the API_KEY column. The API_KEY displays a masked value if an API key was entered. (This does not display either the original unencrypted key or the encrypted version of the key.)

Examples

Create a notification integration:

CREATE NOTIFICATION INTEGRATION myint ( ... );

Describe the columns in the integration:

DESC INTEGRATION myint;