Ampersand Notification API
The Notification API from Ampersand — 2 operation(s) for notification.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/ampersand:ampersand-notification-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Ampersand public Notification API
version: 1.0.0
servers:
- url: https://api.withampersand.com/v1
security:
- APIKeyHeader: []
- Bearer: []
tags:
- name: Notification
paths:
/projects/{projectIdOrName}/notification-event-topic-routes:
post:
summary: Ampersand Create a Notification Event-topic Route
operationId: createEventTopicRoute
tags:
- Notification
parameters:
- name: projectIdOrName
in: path
required: true
description: The Ampersand project ID or project name.
schema:
type: string
example: my-project
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- eventType
- 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
topicId:
type: string
description: The ID of the topic to route events to.
examples:
route_example:
summary: Create event-topic route
value:
eventType: installation.created
topicId: 1234567890abcdef
responses:
201:
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationEventTopicRoute'
400:
description: Bad Request
content:
application/problem+json:
schema:
$ref: ../problem/problem.yaml#/components/schemas/ApiProblem
422:
description: Unprocessable Entity
content:
application/problem+json:
schema:
$ref: ../problem/problem.yaml#/components/schemas/InputValidationProblem
default:
description: Error
content:
application/problem+json:
schema:
$ref: ../problem/problem.yaml#/components/schemas/ApiProblem
x-codegen-request-body-name: eventTopicRoute
get:
summary: Ampersand List Notification Event-topic Routes
operationId: listEventTopicRoutes
tags:
- Notification
parameters:
- name: projectIdOrName
in: path
required: true
description: The Ampersand project ID or project name.
schema:
type: string
- name: topicId
in: query
required: false
description: Filter by topic ID.
schema:
type: string
- name: eventType
in: query
required: false
description: Filter by notification event type.
schema:
$ref: '#/components/schemas/NotificationEventType'
responses:
200:
description: List of event-topic routes
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationEventTopicRoute'
default:
description: Error
content:
application/problem+json:
schema:
$ref: ../problem/problem.yaml#/components/schemas/ApiProblem
/projects/{projectIdOrName}/notification-event-topic-routes/{routeId}:
delete:
summary: Ampersand Delete a Notification Event-topic Route
operationId: deleteEventTopicRoute
tags:
- Notification
parameters:
- name: projectIdOrName
in: path
required: true
description: The Ampersand project ID or project name.
schema:
type: string
- name: routeId
in: path
required: true
description: The event-topic route ID.
schema:
type: string
responses:
204:
description: Deleted
404:
description: Route not found
content:
application/problem+json:
schema:
$ref: ../problem/problem.yaml#/components/schemas/InputValidationProblem
default:
description: Error
content:
application/problem+json:
schema:
$ref: ../problem/problem.yaml#/components/schemas/ApiProblem
components:
schemas:
NotificationEventTopicRoute:
title: Notification Event Topic Route
required:
- id
- eventType
- topicId
- projectId
- createTime
type: object
properties:
id:
type: string
description: The event-topic route ID.
eventType:
$ref: '#/components/schemas/NotificationEventType'
topicId:
type: string
description: The ID of the topic to route events to.
projectId:
type: string
description: The Ampersand project ID.
createTime:
type: string
format: date-time
description: The time when the event-topic route was created.
updateTime:
type: string
format: date-time
description: The time when the event-topic route was last updated.
NotificationEventType:
type: string
description: The type of notification event.
enum:
- connection.created
- connection.error
- connection.refreshed
- connection.deleted
- installation.created
- installation.updated
- installation.deleted
- read.schedule.paused
- read.backfill.done
- read.triggered.done
- read.triggered.error
- write.async.done
- destination.webhook.disabled
securitySchemes:
APIKeyHeader:
type: apiKey
name: X-Api-Key
in: header
Bearer:
type: http
scheme: bearer
bearerFormat: JWT
x-provenance:
method: harvested
publisher: Ampersand
source: https://raw.githubusercontent.com/amp-labs/openapi/HEAD/api/api.yaml
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)