WHERE DO I START?
You are here:... (Miscellaneous) > API > Notifications
  • Top ↑

Notifications

The notifications API allows you to access and create notifications.

Tip   To explore Netuitive's REST API and test some requests, go here.

Get a list of your notifications

This method will automatically return a list of notifications created for the tenant you are authenticated for.

Method GET URL https://api.app.netuitive.com/notifications
Parameters Required/Optional Description
N/A N/A N/A

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Create a notification

This method will create a notification.

Method POST URL https://api.app.netuitive.com/notifications
Parameters Required/Optional Description
notification Required Body parameter; see below.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Input JSON Format for Request Body

Attribute Required/Optional Description
notification Required
  • id (optional)
    • The notification ID. If left blank, Netuitive will create one for you.
  • tenantId (optional)
    • The ID for the tenant that the notification was created for. If left blank, Netuitive will use the Tenant ID associated with your authentication login.
  • enabled (optional)
    • True or false; if the notification is enabled.
  • type (required)
    • The type of notification: email, hipchat, webhook, opsgenie, or pagerduty.
  • properties (required)
    • The fields filled out for each notification type.

Test a notification

This method will allow you to test a notification.

Method POST URL https://api.app.netuitive.com/notifications/test
Parameters Required/Optional Description
notification Required Body parameter; see below.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Input JSON Format for Request Body

Attribute Required/Optional Description
notification Required
  • id (required)
    • The notification ID.
  • tenantId (required)
    • The ID for the tenant that the notification was created for.
  • enabled (optional)
    • True or false; if the notification is enabled.
  • type (required)
    • The type of notification: email, hipchat, webhook, opsgenie, or pagerduty.
  • properties (required)
    • The fields filled out for each notification type. See above for more information.
      Example(s)   For an email notification, the properties attribute would contain templateType, address, bodyTemplate, and subjectTemplate.

Delete a notification

This method will delete a given notification.

Method DELETE URL https://api.app.netuitive.com/notifications/{id}
Important   Replace {id} in the above URL with a notification ID from any of your notifications.
Parameters Required/Optional Description
id Required URL (path) parameter. Your notification ID.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Get a notification by ID

This method will return a notification for the given ID.

Method GET URL https://api.app.netuitive.com/notifications/{id}
Important   Replace {id} in the above URL with a notification ID from any of your notifications.
Parameters Required/Optional Description
id Required URL (path) parameter. Your notification ID.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Replace a notification

This method will allow you to replace a given notification.

Method PUT URL https://api.app.netuitive.com/notifications/{id}
Important   Replace {id} in the above URL with a notification ID from any of your notifications.
Parameters Required/Optional Description
id Required URL (path) parameter. Your notification ID.
notification Required Body parameter. See below.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Input JSON Format for Request Body

Attribute Required/Optional Description
notification Required
  • id (required)
    • The notification ID.
  • tenantId (required)
    • The ID for the tenant that the notification was created for.
  • enabled (optional)
    • True or false; if the notification is enabled.
  • type (required)
    • The type of notification: email, hipchat, webhook, opsgenie, or pagerduty.
  • properties (required)
    • The fields filled out for each notification type. See above for more information.
      Example(s)   For an email notification, the properties attribute would contain templateType, address, bodyTemplate, and subjectTemplate.