Skip to content

notifications: add read.backfill.error event type #405

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

Open
jlimatampersand wants to merge 2 commits into
base: main
Choose a base branch
from
Open

notifications: add read.backfill.error event type #405

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
6323e93
notifications: add read.backfill.error event type
jlimatampersand Sep 8, 2026
d318ce0
Apply suggestion from @graphite-app[bot]
jlimatampersand Sep 10, 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
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 @@ -7255,6 +7255,7 @@ components:
- "installation.deleted"
- "read.schedule.paused"
- "read.backfill.done"
- "read.backfill.error"
- "read.triggered.done"
- "read.triggered.error"
- "write.async.done"
Expand Down
1 change: 1 addition & 0 deletions api/generated/api.bundled.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10332,6 +10332,7 @@
"installation.deleted",
"read.schedule.paused",
"read.backfill.done",
"read.backfill.error",
"read.triggered.done",
"read.triggered.error",
"write.async.done",
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 @@ -61929,6 +61929,7 @@
"installation.deleted",
"read.schedule.paused",
"read.backfill.done",
"read.backfill.error",
"read.triggered.done",
"read.triggered.error",
"write.async.done",
Expand Down Expand Up @@ -61993,6 +61994,7 @@
"installation.deleted",
"read.schedule.paused",
"read.backfill.done",
"read.backfill.error",
"read.triggered.done",
"read.triggered.error",
"write.async.done",
Expand Down Expand Up @@ -62669,6 +62671,7 @@
"installation.deleted",
"read.schedule.paused",
"read.backfill.done",
"read.backfill.error",
"read.triggered.done",
"read.triggered.error",
"write.async.done",
Expand Down Expand Up @@ -62719,6 +62722,7 @@
"installation.deleted",
"read.schedule.paused",
"read.backfill.done",
"read.backfill.error",
"read.triggered.done",
"read.triggered.error",
"write.async.done",
Expand Down Expand Up @@ -78323,6 +78327,7 @@
"installation.deleted",
"read.schedule.paused",
"read.backfill.done",
"read.backfill.error",
"read.triggered.done",
"read.triggered.error",
"write.async.done",
Expand Down Expand Up @@ -78369,6 +78374,7 @@
"installation.deleted",
"read.schedule.paused",
"read.backfill.done",
"read.backfill.error",
"read.triggered.done",
"read.triggered.error",
"write.async.done",
Expand Down
203 changes: 203 additions & 0 deletions notifications/generated/notifications.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,6 +496,99 @@
}
]
},
"ReadBackfillErrorData": {
"title": "Read Backfill Error Data",
"description": "Data payload for read.backfill.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",
"required": [
"objectName"
],
"properties": {
"objectName": {
"type": "string",
"description": "The name of the object for which the backfill failed.",
"example": "Account"
},
"error": {
"type": "string",
"description": "The error that occurred during the backfill.",
"example": "Authentication failed"
}
}
}
]
},
"ReadSchedulePausedData": {
"title": "Read Schedule Paused Data",
"description": "Data payload for read.schedule.paused notifications.",
Expand Down Expand Up @@ -2039,6 +2132,116 @@
}
}
},
"ReadBackfillErrorNotificationPayload": {
"title": "Read Backfill Error Notification Payload",
"description": "Payload structure for read.backfill.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": [
"read.backfill.error"
]
},
"data": {
"title": "Read Backfill Error Data",
"description": "Data payload for read.backfill.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",
"required": [
"objectName"
],
"properties": {
"objectName": {
"type": "string",
"description": "The name of the object for which the backfill failed.",
"example": "Account"
},
"error": {
"type": "string",
"description": "The error that occurred during the backfill.",
"example": "Authentication failed"
}
}
}
]
}
}
},
"ReadSchedulePausedNotificationPayload": {
"title": "Read Schedule Paused Notification Payload",
"description": "Payload structure for read.schedule.paused notifications sent to webhook destinations.\nFor Kinesis destinations, only the `data` object is sent.\n",
Expand Down
37 changes: 37 additions & 0 deletions notifications/notifications.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,27 @@ components:
type: string
description: The name of the object for which the backfill completed.
example: Account
# Read backfill failed event data
ReadBackfillErrorData:
title: Read Backfill Error Data
description: Data payload for read.backfill.error notifications.
allOf:
- $ref: '#/components/schemas/InstallationFields'
- type: object

required:
- objectName
- error
properties:
objectName:
type: string
description: The name of the object for which the backfill failed.
example: Account
error:
type: string
description: The error that occurred during the backfill.
example: "Authentication failed"
Comment thread
jlimatampersand marked this conversation as resolved.

# Read schedule paused event data
ReadSchedulePausedData:
title: Read Schedule Paused Data
Expand Down Expand Up @@ -500,6 +521,22 @@ components:
data:
$ref: '#/components/schemas/ReadBackfillDoneData'

ReadBackfillErrorNotificationPayload:
title: Read Backfill Error Notification Payload
description: |
Payload structure for read.backfill.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: [read.backfill.error]
data:
$ref: '#/components/schemas/ReadBackfillErrorData'

ReadSchedulePausedNotificationPayload:
title: Read Schedule Paused Notification Payload
description: |
Expand Down
Loading