Skip to content

[ENG-3967] openapi: subscribe.create.error notif #362

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 2 commits into from
Jun 15, 2026
Merged

[ENG-3967] openapi: subscribe.create.error notif #362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a695d31
"subscribe.create.error notif"
AmandaYao00 Jun 15, 2026
8918789
update endpoint with notif types
AmandaYao00 Jun 15, 2026
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
16 changes: 2 additions & 14 deletions api/api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4008,20 +4008,7 @@ paths:
- topicId
properties:
eventType:
type: string
description: The type of notification event.
enum:
- "read.backfill.done"
- "connection.created"
- "connection.error"
- "connection.refreshed"
- "connection.deleted"
- "installation.created"
- "installation.updated"
- "installation.deleted"
- "read.schedule.paused"
- "write.async.done"
- "destination.webhook.disabled"
$ref: "#/components/schemas/NotificationEventType"
topicId:
type: string
description: The ID of the topic to route events to.
Expand Down Expand Up @@ -6541,6 +6528,7 @@ components:
- "read.triggered.done"
- "read.triggered.error"
- "write.async.done"
- "subscribe.create.error"
- "destination.webhook.disabled"
TopicDestinationRoute:
title: Topic Destination Route
Expand Down
10 changes: 9 additions & 1 deletion api/generated/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59410,7 +59410,6 @@
"type": "string",
"description": "The type of notification event.",
"enum": [
"read.backfill.done",
"connection.created",
"connection.error",
"connection.refreshed",
Expand All @@ -59419,7 +59418,11 @@
"installation.updated",
"installation.deleted",
"read.schedule.paused",
"read.backfill.done",
"read.triggered.done",
"read.triggered.error",
"write.async.done",
"subscribe.create.error",
"destination.webhook.disabled"
]
},
Expand Down Expand Up @@ -59477,6 +59480,7 @@
"read.triggered.done",
"read.triggered.error",
"write.async.done",
"subscribe.create.error",
"destination.webhook.disabled"
]
},
Expand Down Expand Up @@ -60146,6 +60150,7 @@
"read.triggered.done",
"read.triggered.error",
"write.async.done",
"subscribe.create.error",
"destination.webhook.disabled"
]
}
Expand Down Expand Up @@ -60189,6 +60194,7 @@
"read.triggered.done",
"read.triggered.error",
"write.async.done",
"subscribe.create.error",
"destination.webhook.disabled"
]
},
Expand Down Expand Up @@ -74921,6 +74927,7 @@
"read.triggered.done",
"read.triggered.error",
"write.async.done",
"subscribe.create.error",
"destination.webhook.disabled"
]
},
Expand Down Expand Up @@ -74960,6 +74967,7 @@
"read.triggered.done",
"read.triggered.error",
"write.async.done",
"subscribe.create.error",
"destination.webhook.disabled"
]
},
Expand Down
187 changes: 187 additions & 0 deletions notifications/generated/notifications.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -919,6 +919,91 @@
}
]
},
"SubscribeCreateErrorData": {
"title": "Subscribe Create Error Data",
"description": "Data payload for subscribe.create.error notifications.",
"allOf": [
{
"title": "Installation Fields",
"type": "object",
"description": "Common fields present in installation-related notifications.",
"required": [
"projectId",
"provider",
"integrationId",
"integrationName",
"installationId",
"groupRef",
"groupName",
"connectionId",
"consumerRef",
"consumerName"
],
"properties": {
"projectId": {
"type": "string",
"description": "The Ampersand Project ID.",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"provider": {
"type": "string",
"description": "The SaaS API that we are integrating with.",
"example": "salesforce"
},
"integrationId": {
"type": "string",
"description": "The ID of the integration.",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"integrationName": {
"type": "string",
"description": "The name of the integration.",
"example": "Salesforce Integration"
},
"installationId": {
"type": "string",
"description": "The ID of the Ampersand installation.",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"connectionId": {
"type": "string",
"description": "The ID of the connection.",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"groupRef": {
"type": "string",
"description": "The ID that your app uses to identify the group of users.",
"example": "customer-group-ref"
},
"groupName": {
"type": "string",
"description": "The display name of the group of users.",
"example": "Customer Name"
},
"consumerRef": {
"type": "string",
"description": "The reference ID of the consumer that triggered the notification.",
"example": "user-123"
},
"consumerName": {
"type": "string",
"description": "The name of the consumer that triggered the notification.",
"example": "John Doe"
}
}
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "The error that occurred while setting up the subscribe action.",
"example": "Failed to create subscription"
}
}
}
]
},
"ConnectionData": {
"title": "Connection Data",
"description": "Data payload for connection.created, connection.refreshed, and connection.deleted notifications.",
Expand Down Expand Up @@ -2050,6 +2135,108 @@
}
}
},
"SubscribeCreateErrorNotificationPayload": {
"title": "Subscribe Create Error Notification Payload",
"description": "Payload structure for subscribe.create.error 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": [
"subscribe.create.error"
]
},
"data": {
"title": "Subscribe Create Error Data",
"description": "Data payload for subscribe.create.error notifications.",
"allOf": [
{
"title": "Installation Fields",
"type": "object",
"description": "Common fields present in installation-related notifications.",
"required": [
"projectId",
"provider",
"integrationId",
"integrationName",
"installationId",
"groupRef",
"groupName",
"connectionId",
"consumerRef",
"consumerName"
],
"properties": {
"projectId": {
"type": "string",
"description": "The Ampersand Project ID.",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"provider": {
"type": "string",
"description": "The SaaS API that we are integrating with.",
"example": "salesforce"
},
"integrationId": {
"type": "string",
"description": "The ID of the integration.",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"integrationName": {
"type": "string",
"description": "The name of the integration.",
"example": "Salesforce Integration"
},
"installationId": {
"type": "string",
"description": "The ID of the Ampersand installation.",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"connectionId": {
"type": "string",
"description": "The ID of the connection.",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"groupRef": {
"type": "string",
"description": "The ID that your app uses to identify the group of users.",
"example": "customer-group-ref"
},
"groupName": {
"type": "string",
"description": "The display name of the group of users.",
"example": "Customer Name"
},
"consumerRef": {
"type": "string",
"description": "The reference ID of the consumer that triggered the notification.",
"example": "user-123"
},
"consumerName": {
"type": "string",
"description": "The name of the consumer that triggered the notification.",
"example": "John Doe"
}
}
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "The error that occurred while setting up the subscribe action.",
"example": "Failed to create subscription"
}
}
}
]
}
}
},
"ConnectionCreatedNotificationPayload": {
"title": "Connection Created Notification Payload",
"description": "Payload structure for connection.created notifications sent to webhook destinations.\nFor Kinesis destinations, only the `data` object is sent.\n",
Expand Down
29 changes: 29 additions & 0 deletions notifications/notifications.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,19 @@ components:
type: string
example: ["field validation failed", "duplicate record"]

# Subscribe create error event data
SubscribeCreateErrorData:
title: Subscribe Create Error Data
description: Data payload for subscribe.create.error notifications.
allOf:
- $ref: '#/components/schemas/InstallationFields'
- type: object
properties:
error:
type: string
description: The error that occurred while setting up the subscribe action.
example: "Failed to create subscription"

# Connection event data
ConnectionData:
title: Connection Data
Expand Down Expand Up @@ -490,6 +503,22 @@ components:
data:
$ref: '#/components/schemas/WriteAsyncDoneData'

SubscribeCreateErrorNotificationPayload:
title: Subscribe Create Error Notification Payload
description: |
Payload structure for subscribe.create.error notifications sent to webhook destinations.
For Kinesis destinations, only the `data` object is sent.
type: object
required:
- notificationType
- data
properties:
notificationType:
type: string
enum: [subscribe.create.error]
data:
$ref: '#/components/schemas/SubscribeCreateErrorData'

ConnectionCreatedNotificationPayload:
title: Connection Created Notification Payload
description: |
Expand Down
Loading