Sign in
Integrations (notifications/v1)

Update an Integration

General Availability

Make a request to update an integration.

patch/notifications/v1/integrations/{id}

Path parameters

idstring required

The unique identifier for the integration.

Request body

api_version'notifications/v1'

APIVersion defines the schema version of this representation of a resource.

kind'Integration'

Kind defines the object this REST resource represents.

idstring

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").

display_namestring

A human readable name for the particular integration

descriptionstring

A human readable description for the particular integration

Example request

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/notifications/v1/integrations/i-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/integration=i-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "display_name": "Slack integration",
  "description": "A Slack channel integration",
  "target": {
    "kind": "Slack",
    "webhook_url": "https://hooks.slack.com/services/{id}/{id}/{id}"
  }
}

Response

Integration.

api_version'notifications/v1' required

APIVersion defines the schema version of this representation of a resource.

kind'Integration' required

Kind defines the object this REST resource represents.

idstring required

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").

display_namestring required

A human readable name for the particular integration

descriptionstring

A human readable description for the particular integration

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/notifications/v1/integrations/i-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/integration=i-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "display_name": "Slack integration",
  "description": "A Slack channel integration",
  "target": {
    "kind": "Slack",
    "webhook_url": "https://hooks.slack.com/services/{id}/{id}/{id}"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.