How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Confluent Integrations (notifications/v1) API

[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)You can create an `Integration` to specify how we can notify you when we receive an alert/notification fora subscription. Please note that you can only perform create, update and delete operations for integrationsof type `Webhook`, `Slack` and `MsTeams`. You cannot create, update or delete integrations of type `RoleEmail`and `UserEmail`.Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud).## The Integrations Model## Quotas and LimitsThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):| Quota | Description || --- | --- || `integrations_per_org` | Maximum number of integrations in one Confluent Cloud organization |

Confluent Integrations (notifications/v1) API is one of 127 APIs that Confluent publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Integrations (notifications/v1). The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 6 operations across 3 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://api.confluent.cloud.

6 operations 3 paths 14 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://api.confluent.cloud
Authentication
HTTP Basic, OAuth 2.0, HTTP Basic, HTTP Basic, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 6

Confluent Integrations (notifications/v1) API declares 6 security schemes for authenticating requests. It accepts HTTP basic authentication (cloud-api-key). It supports OAuth 2.0 (confluent-sts-access-token) using the clientCredentials flow. It accepts HTTP basic authentication (global-api-key). It accepts HTTP basic authentication (resource-api-key). It supports OAuth 2.0 (external-access-token) using the clientCredentials flow. It supports OAuth 2.0 (oauth) using the clientCredentials flow, exposing 4 scopes.

  • cloud-api-key — Authenticate with Cloud API Keys using HTTP Basic Auth. Treat the Cloud API Key ID as the username and Cloud API Key Secret as the password.
  • confluent-sts-access-token — Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
  • global-api-key — Authenticate with Global API Keys using HTTP Basic Auth. Treat the Global API Key ID as the username and Global API Key Secret as the password.
  • resource-api-key — Authenticate with resource-specific API Keys using HTTP Basic Auth. Treat the resource-specific API Key ID as the username and resource-specific API Key Secret…
  • external-access-token — Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
  • oauth — Authenticate with OAuth 2.0. Currently this is only supported for partner APIs.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Integrations (notifications/v1) 6

[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](section/Versioning/API-Lifecycle-Policy) You can create an Integration t…

POST
/notifications/v1/integrations
Create an Integration
createNotificationsV1Integration body → 201400401402403409422429
GET
/notifications/v1/integrations
Retrieve a list of integrations. Optionally filter by resource and resource type.
listNotificationsV1Integrations 4 params → 200400401403404429500
GET
/notifications/v1/integrations/{id}
Read an Integration
getNotificationsV1Integration 1 param → 200400401403404429500
PATCH
/notifications/v1/integrations/{id}
Update an Integration
updateNotificationsV1Integration 1 param body → 200400401402403404409422
DELETE
/notifications/v1/integrations/{id}
Delete an Integration
deleteNotificationsV1Integration 1 param → 204400401403404429500
POST
/notifications/v1/integrations:test
Test a Webhook, Slack or Microsoft Teams integration
testNotificationsV1Integration body → 204400401403404429500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Error (8 properties), notifications.v1.Integration (7 properties), ObjectMeta (5 properties), ListMeta (5 properties). Each schema is shown below with its type and property counts.

notifications.v1.WebhookTarget
object
Target required for webhook integration
2 properties 2 required
ObjectMeta
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
5 properties 1 required
ListMeta
object
ListMeta describes metadata that resource collections may have
5 properties
notifications.v1.UserEmailTarget
object
Email integration target to send email to a particular user
2 properties 2 required
notifications.v1.Integration
object
You can create an Integration to specify how we can notify you when we receive an alert/notification for a subscription. Please note that you can only perform…
7 properties
notifications.v1.SlackTarget
object
Target required for Slack integration
2 properties 2 required
notifications.v1.MsTeamsTarget
object
Target required for MS Teams integration
2 properties 2 required
notifications.v1.InAppTarget
object
Per-user in-app notification target; lazy-onboarded on first read.
2 properties 2 required
notifications.v1.RoleEmailTarget
object
Email integration target to send email to all user with specified role
2 properties 2 required
notifications.v1.Target
Target for the particular integration
Error
object
Describes a particular error encountered while performing an operation.
8 properties
GlobalObjectReference
object
ObjectReference provides information for you to locate the referred object
3 properties 3 required
Failure
object
Provides information about problems encountered while performing an operation.
1 property 1 required
notifications.v1.IntegrationList
object
You can create an Integration to specify how we can notify you when we receive an alert/notification for a subscription. Please note that you can only perform…
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

confluent-integrations-notifications-v1-api-openapi.yml Raw ↑

Other APIs Confluent publishes across the network.

Confluent
Confluent Managed MCP Servers
Confluent ACLs API
Confluent API Keys API
Confluent Clusters API
Confluent Consumer Groups API
Confluent Environments API
Confluent Partitions API
Confluent Service Accounts API
Confluent Topics API
Confluent Access Points (networking/v1) API
Confluent ACL (v3) API
Where this information came from

This is an independent, third-party profile of Confluent Integrations (notifications/v1) API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.