Create notification

post

https://{sandfly-api-host}/v4/notifications

Create a new event notification configuration.

Body Params

config

required

template

string

required

The Go text/template template to format the notification content.

name

string

required

Name of notification configuration.

event

string

enum

required

Event type for which this notification will fire.

Allowed:

delivery

string

enum

required

Method used to deliver event notification.

Allowed:

hosts_tags_include

array of strings | null

required

If present, only events that apply to the hosts that have the tag(s) will be sent by this notification.

hosts_tags_include*

hosts_tags_include_operator

string

enum

Defaults to and

If there are more than one hosts_tags_include tags, this operator controls the matching logic.

Allowed:

hosts_tags_exclude

array of strings | null

required

If present, events will NOT be sent for any hosts that have these tag(s). Exclude tags have priority over include tags.

hosts_tags_exclude*

hosts_tags_exclude_operator

string

enum

Defaults to and

If there are more than one hosts_tags_exclude tags, this operator controls the matching logic.

Allowed:

paused

boolean

Defaults to true

Holds the active status of the notification.

Responses

Language

Credentials

Bearer

JWT

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Notification created.

400Invalid request body.

402Cannot create new notification because the number of allowed notifications by the license has been reached.

403User is not permitted to perform this action.

defaultUnexpected error