Notification API Reference

Methods

notification.count(apikey)

Count notification entries.

Parameters:apikey (string) – API connection key
Returns:int – number of notification entries
notification.list(apikey)

List notifications and their associated channels.

Parameters:apikey (string) – API connection key
Returns:struct – list of notification entries
notification.test(apikey, notification)

Send a test message through all subscribed protocols for specified notification.

New in version 3.3.24.

Parameters:
  • apikey (string) – API connection key
  • notification (string) – Notification name
Returns:

boolean – 1 on success
notification.subscription.count(apikey)

Count subscriptions to notification channels.

Parameters:apikey (string) – API connection key
Returns:int – number of notification subscriptions
notification.subscription.create(apikey, params)

Subscribe to a notification.

Parameters:
Returns:

struct – Operation notification_subscription_create
notification.subscription.delete(apikey, params)

Unsubscribe to a notification.

Parameters:
Returns:

struct – Operation notification_subscription_delete
notification.subscription.list(apikey)

List subscriptions to notification channels.

Parameters:apikey (string) – API connection key
Returns:struct – list of notification subscriptions

Parameters

NotificationProtocolEnum

used by NotificationSubscriptionParam

Name Description
smtp -
irc -
xmpp -
NotificationSubscriptionParam

parameter of notification.subscription.create() and notification.subscription.delete()

Name Default Type Mandatory
address   string yes
channel   string yes
notification   string yes
lang   string no

Returns

NotificationChannelListReturn

used by NotificationListReturn

Name Type
name string
status string
NotificationListReturn

returned by notification.list()

Name Type
active boolean
channels array of struct
name string
NotificationSubscriptionListReturn

returned by notification.subscription.list()

Name Type
address string
channel string
endpoint string
lang string
notification string