Skip to content

[ENG-4112] docs: update notification docs #646

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] docs: update notification docs #646

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
4 changes: 2 additions & 2 deletions src/notifications/notification-payloads.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,8 +413,8 @@ Note: For partial failures, `success` is `false` with both `successfulRecordIds`

</Accordion>

<Accordion title="Connection events (created, refreshed, deleted)">
`connection.created`, `connection.refreshed`, and `connection.deleted` share the same payload shape. `notificationType` reflects the specific event.
<Accordion title="Connection events (created, refreshed, updated, deleted)">
`connection.created`, `connection.refreshed`, `connection.updated`, and `connection.deleted` share the same payload shape. `notificationType` reflects the specific event.

**Webhook destination payload:**
```json
Expand Down
7 changes: 4 additions & 3 deletions src/notifications/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,13 @@ Ampersand supports the following notification event types:

**Connection**
- **`connection.created`**: Fires when a new OAuth connection is established with a SaaS provider
- **`connection.refreshed`**: Fires when a connection's OAuth access token is refreshed
- **`connection.deleted`**: Fires when a connection is deleted
- **`connection.refreshed`**: Fires when Ampersand automatically refreshes a connection's OAuth access token as it nears expiry, using the connection's refresh token. This happens with no user involvement and keeps the connection active
- **`connection.updated`**: Fires when an existing connection is updated, either when a user re-authenticates (for example, reconnecting to resolve an errored connection) or when the connection's credentials or metadata are changed via the update connection API
- **`connection.deleted`**: Fires when a connection is deleted, such as through the dashboard or the delete connection API
- **`connection.error`**: Fires when there's an error with an OAuth connection, such as authentication failures or token refresh issues

**Destination**
- **`destination.webhook.disabled`**: Fires when a webhook destination endpoint is disabled
- **`destination.webhook.disabled`**: Fires when a webhook destination endpoint is disabled. This can happen automatically after repeated failed delivery attempts.

## Setting up notifications

Expand Down
Loading