HoxtonAi
Powered by Redocly

Notification Groups

APIs to manage an organisation's notification groups.

Create/Update notification group

Update a notification group exists if exists, create a new one otherwise.

Securityo_auth
Request
Request Body schema: application/json
required

A notification group to send alerts to.

emails
Array of strings <email>
id
string or null <uuid>
name
required
string
organisationId
required
string <uuid>
state
string
Enum: "active" "deleted"
webhook
object
Responses
201

OK.

204

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

410

Gone.

422

Unprocessable entity.

500

Failed.

put/notification-groups
Request samples
application/json
{
  • "emails": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "state": "active",
  • "webhook": { }
}
Response samples
application/json
{
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "emails": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "state": "active",
  • "webhook": { }
}

Delete notification group

Set the state of a notification group to deleted.

Securityo_auth
Request
path Parameters
notificationGroupId
required
string <uuid>

the ID of the notification group to delete.

Responses
204

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

404

Not found.

410

Gone.

422

Unprocessable entity.

500

Failed.

delete/notification-groups/{notificationGroupId}
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string"
}
Get notification group
Get a notification group identified by the provided ID.


Securityo_auth 
Request 
path Parameters
notificationGroupId
required
string <uuid> 
The ID of the notification group to get.


 
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


404
Not found.


422
Unprocessable entity.


500
Failed.


get/notification-groups/{notificationGroupId}
Request samples 
Response samples 
application/json
{
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "emails": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "state": "active",
  • "webhook": { }
}
List notification groups
Get all notification groups subject to filters.


Securityo_auth 
Request 
query Parameters
notificationGroupId
string <uuid> 
The ID of the notification group to get.


 
alertId
string <uuid> 
The ID of the alert rule a notification group is linked to.


 
organisationId
string <uuid> 
The ID of the organisation the notification groups are linked to.


 
state
string
The state of the notification group.


 Enum: "active" "deleted"  
userId
string
The ID of a user on whose visibility of the notification groups to filter on.


 
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


422
Unprocessable entity.


500
Failed.


get/notification-groups
Request samples 
Response samples 
application/json
[
  • {
    }
]