Skip to content

[ENG-4112] openapi: connection.updated notification #370

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AmandaYao00 merged 1 commit into from
Jul 7, 2026
Merged

[ENG-4112] openapi: connection.updated notification #370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions api/api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6572,6 +6572,7 @@ components:
- "connection.created"
- "connection.error"
- "connection.refreshed"
- "connection.updated"
- "connection.deleted"
- "installation.created"
- "installation.updated"
Expand Down
7 changes: 7 additions & 0 deletions api/generated/api.bundled.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9526,6 +9526,7 @@
"connection.created",
"connection.error",
"connection.refreshed",
"connection.updated",
"connection.deleted",
"installation.created",
"installation.updated",
Expand Down Expand Up @@ -11606,6 +11607,12 @@
},
"accessTokenOpts": {
"$ref": "#/components/schemas/AccessTokenOpts"
},
"keepAliveIntervalHours": {
"type": "integer",
"description": "How many hours between proactive token keep-alive refreshes for this provider.\nToken-manager adds a random stagger offset on top. If absent, defaults to 24.\n",
"example": 120,
"x-go-type-skip-optional-pointer": true
}
}
},
Expand Down
6 changes: 6 additions & 0 deletions api/generated/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59517,6 +59517,7 @@
"connection.created",
"connection.error",
"connection.refreshed",
"connection.updated",
"connection.deleted",
"installation.created",
"installation.updated",
Expand Down Expand Up @@ -59575,6 +59576,7 @@
"connection.created",
"connection.error",
"connection.refreshed",
"connection.updated",
"connection.deleted",
"installation.created",
"installation.updated",
Expand Down Expand Up @@ -60245,6 +60247,7 @@
"connection.created",
"connection.error",
"connection.refreshed",
"connection.updated",
"connection.deleted",
"installation.created",
"installation.updated",
Expand Down Expand Up @@ -60289,6 +60292,7 @@
"connection.created",
"connection.error",
"connection.refreshed",
"connection.updated",
"connection.deleted",
"installation.created",
"installation.updated",
Expand Down Expand Up @@ -75052,6 +75056,7 @@
"connection.created",
"connection.error",
"connection.refreshed",
"connection.updated",
"connection.deleted",
"installation.created",
"installation.updated",
Expand Down Expand Up @@ -75092,6 +75097,7 @@
"connection.created",
"connection.error",
"connection.refreshed",
"connection.updated",
"connection.deleted",
"installation.created",
"installation.updated",
Expand Down
74 changes: 68 additions & 6 deletions notifications/generated/notifications.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1006,7 +1006,7 @@
},
"ConnectionData": {
"title": "Connection Data",
"description": "Data payload for connection.created, connection.refreshed, and connection.deleted notifications.",
"description": "Data payload for connection.created, connection.refreshed, connection.updated, and connection.deleted notifications.",
"type": "object",
"required": [
"projectId",
Expand Down Expand Up @@ -1055,7 +1055,7 @@
"allOf": [
{
"title": "Connection Data",
"description": "Data payload for connection.created, connection.refreshed, and connection.deleted notifications.",
"description": "Data payload for connection.created, connection.refreshed, connection.updated, and connection.deleted notifications.",
"type": "object",
"required": [
"projectId",
Expand Down Expand Up @@ -2254,7 +2254,7 @@
},
"data": {
"title": "Connection Data",
"description": "Data payload for connection.created, connection.refreshed, and connection.deleted notifications.",
"description": "Data payload for connection.created, connection.refreshed, connection.updated, and connection.deleted notifications.",
"type": "object",
"required": [
"projectId",
Expand Down Expand Up @@ -2320,7 +2320,7 @@
"allOf": [
{
"title": "Connection Data",
"description": "Data payload for connection.created, connection.refreshed, and connection.deleted notifications.",
"description": "Data payload for connection.created, connection.refreshed, connection.updated, and connection.deleted notifications.",
"type": "object",
"required": [
"projectId",
Expand Down Expand Up @@ -2412,7 +2412,69 @@
},
"data": {
"title": "Connection Data",
"description": "Data payload for connection.created, connection.refreshed, and connection.deleted notifications.",
"description": "Data payload for connection.created, connection.refreshed, connection.updated, and connection.deleted notifications.",
"type": "object",
"required": [
"projectId",
"connectionId",
"provider",
"groupRef",
"consumerRef",
"consumerName"
],
"properties": {
"projectId": {
"type": "string",
"description": "The Ampersand Project ID.",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"connectionId": {
"type": "string",
"description": "The ID of the connection.",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"provider": {
"type": "string",
"description": "The SaaS API that we are integrating with.",
"example": "salesforce"
},
"groupRef": {
"type": "string",
"description": "The ID that your app uses to identify the group of users.",
"example": "customer-group-ref"
},
"consumerRef": {
"type": "string",
"description": "The reference ID of the consumer.",
"example": "user-123"
},
"consumerName": {
"type": "string",
"description": "The name of the consumer.",
"example": "John Doe"
}
}
}
}
},
"ConnectionUpdatedNotificationPayload": {
"title": "Connection Updated Notification Payload",
"description": "Payload structure for connection.updated notifications sent to webhook destinations.\nFor Kinesis destinations, only the `data` object is sent.\n",
"type": "object",
"required": [
"notificationType",
"data"
],
"properties": {
"notificationType": {
"type": "string",
"enum": [
"connection.updated"
]
},
"data": {
"title": "Connection Data",
"description": "Data payload for connection.created, connection.refreshed, connection.updated, and connection.deleted notifications.",
"type": "object",
"required": [
"projectId",
Expand Down Expand Up @@ -2474,7 +2536,7 @@
},
"data": {
"title": "Connection Data",
"description": "Data payload for connection.created, connection.refreshed, and connection.deleted notifications.",
"description": "Data payload for connection.created, connection.refreshed, connection.updated, and connection.deleted notifications.",
"type": "object",
"required": [
"projectId",
Expand Down
18 changes: 17 additions & 1 deletion notifications/notifications.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ components:
# Connection event data
ConnectionData:
title: Connection Data
description: Data payload for connection.created, connection.refreshed, and connection.deleted notifications.
description: Data payload for connection.created, connection.refreshed, connection.updated, and connection.deleted notifications.
type: object
required:
- projectId
Expand Down Expand Up @@ -567,6 +567,22 @@ components:
data:
$ref: '#/components/schemas/ConnectionData'

ConnectionUpdatedNotificationPayload:
title: Connection Updated Notification Payload
description: |
Payload structure for connection.updated notifications sent to webhook destinations.
For Kinesis destinations, only the `data` object is sent.
type: object
required:
- notificationType
- data
properties:
notificationType:
type: string
enum: [connection.updated]
data:
$ref: '#/components/schemas/ConnectionData'

ConnectionDeletedNotificationPayload:
title: Connection Deleted Notification Payload
description: |
Expand Down
Loading