integrations

Creates, updates, deletes, gets or lists a integrations resource.

Overview

Name	integrations
Type	Resource
Id	confluent.notifications.integrations

Fields

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").
description	string	A human readable description for the particular integration
api_version	string	APIVersion defines the schema version of this representation of a resource.
display_name	string	A human readable name for the particular integration
kind	string	Kind defines the object this REST resource represents.
metadata	``	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
target	``	Integration-specific details (integration targets)

Methods

Name	Accessible by	Required Params	Description
get_notifications_v1integration	SELECT	id	Make a request to read an integration.
list_notifications_v1integrations	SELECT		Retrieve a sorted, filtered, paginated list of all integrations.
create_notifications_v1integration	INSERT		Make a request to create an integration.
delete_notifications_v1integration	DELETE	id	Make a request to delete an integration.
update_notifications_v1integration	UPDATE	id	Make a request to update an integration.
test_notifications_v1integration	EXEC		Sends a test notification to validate the integration. This is supported only for Webhook, Slack and MsTeams targets

SELECT examples

Retrieve a sorted, filtered, paginated list of all integrations.

SELECT
id,
description,
api_version,
display_name,
kind,
metadata,
target
FROM confluent.notifications.integrations
;

INSERT example

Use the following StackQL query and manifest file to create a new integrations resource.

Required Properties

/*+ create */
INSERT INTO confluent.notifications.integrations (
data__display_name,
data__description,
data__target
)
SELECT 
'{{ display_name }}',
'{{ description }}',
'{{ target }}'
;

All Properties

/*+ create */
INSERT INTO confluent.notifications.integrations (
data__display_name,
data__target
)
SELECT 
'{{ display_name }}',
'{{ target }}'
;

Manifest

- name: integrations
  props:
    - name: display_name
      value: string
    - name: description
      value: string
    - name: target
      props:
        - name: kind
          value: string
        - name: webhook_url
          value: string

UPDATE example

Updates a integrations resource.

/*+ update */
UPDATE confluent.notifications.integrations
SET 
display_name = '{{ display_name }}',
description = '{{ description }}',
target = '{{ target }}'
WHERE 
id = '{{ id }}';

DELETE example

Deletes the specified integrations resource.

/*+ delete */
DELETE FROM confluent.notifications.integrations
WHERE id = '{{ id }}';