Skip to main content
POST
/
projects
/
{projectIdOrName}
/
notifications
/
event-topic-routes
Create an event-topic route
curl --request POST \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/notifications/event-topic-routes \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "eventType": "installation.created",
  "topicId": "topic_1234567890abcdef"
}'
{
  "id": "<string>",
  "eventType": "installation.created",
  "topicId": "<string>",
  "projectId": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
projectIdOrName
string
required

The Ampersand project ID or project name.

Body

application/json
​
eventType
enum<string>
required

The type of notification event.

Available options:
read.backfill.done,
connection.created,
installation.created,
installation.updated,
installation.deleted,
read.schedule.paused
​
topicId
string
required

The ID of the notification topic to route events to.

Response

Created

​
id
string
required

The event-topic route ID.

​
eventType
enum<string>
required

The type of notification event.

Available options:
read.backfill.done,
connection.created,
installation.created,
installation.updated,
installation.deleted,
read.schedule.paused
Example:

"installation.created"

​
topicId
string
required

The ID of the notification topic to route events to.

​
projectId
string
required

The Ampersand project ID.

​
createTime
string<date-time>
required

The time when the event-topic route was created.

​
updateTime
string<date-time>

The time when the event-topic route was last updated.