integrations

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

Overview

Name	integrations
Type	Resource
Id	confluent.notifications.integrations

Fields

The following fields are returned by SELECT queries:

get_notifications_v1_integration

Integration.

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"). (example: dlz-f3a90de)
display_name	string	A human readable name for the particular integration (example: Slack integration)
api_version	string	APIVersion defines the schema version of this representation of a resource. (notifications/v1)
description	string	A human readable description for the particular integration (example: A Slack channel integration)
kind	string	Kind defines the object this REST resource represents. (Integration)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
target	object	Integration-specific details (integration targets)

list_notifications_v1_integrations

Integration.

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"). (example: dlz-f3a90de)
display_name	string	A human readable name for the particular integration (example: Slack integration)
api_version	string	APIVersion defines the schema version of this representation of a resource. (notifications/v1)
description	string	A human readable description for the particular integration (example: A Slack channel integration)
kind	string	Kind defines the object this REST resource represents. (Integration)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
target	object	Integration-specific details (integration targets)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_notifications_v1_integration	select	id		Make a request to read an integration.
list_notifications_v1_integrations	select		page_size, page_token	Retrieve a sorted, filtered, paginated list of all integrations.
create_notifications_v1_integration	insert	display_name, target		Make a request to create an integration.
update_notifications_v1_integration	update	id		Make a request to update an integration.
delete_notifications_v1_integration	delete	id		Make a request to delete an integration.
test_notifications_v1_integration	exec	display_name, target		Sends a test notification to validate the integration. This is supported only for Webhook, Slack and MsTeams targets

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The unique identifier for the integration.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_notifications_v1_integration

Make a request to read an integration.

SELECT
id,
display_name,
api_version,
description,
kind,
metadata,
target
FROM confluent.notifications.integrations
WHERE id = '{{ id }}' -- required
;

list_notifications_v1_integrations

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

SELECT
id,
display_name,
api_version,
description,
kind,
metadata,
target
FROM confluent.notifications.integrations
WHERE page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_notifications_v1_integration

Make a request to create an integration.

INSERT INTO confluent.notifications.integrations (
display_name,
description,
target
)
SELECT 
'{{ display_name }}' /* required */,
'{{ description }}',
'{{ target }}' /* required */
RETURNING
id,
display_name,
api_version,
description,
kind,
metadata,
target
;

Manifest

# Description fields are for documentation purposes
- name: integrations
props:
  - name: display_name
    value: "{{ display_name }}"
    description: |
      A human readable name for the particular integration
  - name: description
    value: "{{ description }}"
    description: |
      A human readable description for the particular integration
  - name: target
    description: |
      Integration-specific details (integration targets)
    value:
      kind: "{{ kind }}"
      webhook_url: "{{ webhook_url }}"
      role_name: "{{ role_name }}"
      user:
        id: "{{ id }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"
      url: "{{ url }}"

UPDATE examples

update_notifications_v1_integration

Make a request to update an integration.

UPDATE confluent.notifications.integrations
SET 
display_name = '{{ display_name }}',
description = '{{ description }}',
target = '{{ target }}'
WHERE 
id = '{{ id }}' --required
RETURNING
id,
display_name,
api_version,
description,
kind,
metadata,
target;

DELETE examples

delete_notifications_v1_integration

Make a request to delete an integration.

DELETE FROM confluent.notifications.integrations
WHERE id = '{{ id }}' --required
;

Lifecycle Methods

test_notifications_v1_integration

Sends a test notification to validate the integration. This is supported only for Webhook, Slack
and MsTeams targets

EXEC confluent.notifications.integrations.test_notifications_v1_integration 
@@json=
'{
"display_name": "{{ display_name }}", 
"description": "{{ description }}", 
"target": "{{ target }}"
}'
;