About Notification Configurations

What are Notification Configurations?

Notification Configurations allows us to configure notifications settings on Cirro.

Endpoints

GET https://api.cirro.io/v2/notification_configurations

The Notification Configuration object

Notification Configuration Attributes

Attribute	Type	Description
`object`	`string`	The type of the object inside the configurations list, it's 'list'.
`id`	`string`	The unique identifier for the Notification Configuration.
`object`	`string`	The type of the object, in this case, it's 'notification_configuration'.
`deliver_by`	`string`	The method to deliver the notification, for example 'email'.
`format`	`string`	The format of the notification, for example 'html' or 'text'.
`kind`	`string`	The kind of the notification, for example 'standalone' or 'digest'.
`locale`	`string`	The locale for the notification configuration.

Example

{
  "object": "list",
  "url": "/notification_configurations",
  "has_more": false,
  "data": [
    {
      "id": "1",
      "object": "notification_configuration",
      "deliver_by": "email",
      "format": "html",
      "kind": "digest",
      "locale": "de"
    },
    {
      "id": "2",
      "object": "notification_configuration",
      "deliver_by": "email",
      "format": "text",
      "kind": "digest",
      "locale": "de"
    }
  ]
}