About Notification Topics

What are Notification Topics?

The Notification Topic represents the topic for a notification in Cirro. For instance, if you need to send an email after a gig is created, you should create a new Notification Topic, ‘gig_created,’ and add an HTML template for it.

Endpoints

GET https://api.cirro.io/v2/notification_topics/ POST https://api.cirro.io/v2/notification_topics GET https://api.cirro.io/v2/notification_topics/:id POST https://api.cirro.io/v2/notification_topics/:id DELETE https://api.cirro.io/v2/notification_topics/:id

The Notification Topic object

Attribute	Type	Description
`id`	`string`	The unique identifier for the Notification Topic.
`object`	`string`	The type of the object, in this case, it's 'notification_topic'.
`name`	`string`	The name of a topic
`notification_layout_id`	`string`	The unique identifier for the associated Notification Layout.
`preferences`	`hash`	The hash of preferences.

Example

{
  "id": "1",
  "object": "notification_topic",
  "name": "new_gig_invitation",
  "notification_layout_id": "1",
  "preferences": {
    "email": "immediately",
    "microsoft_teams": "never"
  }
}