notification#

Autogenerated API

argus_api.lib.notifications.v1.notification.prepare_notification(customerID: int = None, event: str = None, recipients: dict = None, attachments: dict = None, context: dict = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Prepare a new notification (INTERNAL)

Parameters

  • customerID (int) – Set the customer context of this notification request. If not set, it should default to the current users customer.

  • event (str) – The name of the notification event to trigger. This will determine notification behaviour and rules.

  • recipients (list) – Recipients to notify, either user or non-user.

  • attachments (list) – Attachments to process in this notification. The notification rules and destinations will determine how these are used.

  • context (dict) – The notification context objects. The notification event determines which context objects are expected. Each object should be JSON serializable.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.notifications.v1.notification.prepare_notification_1(notificationID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

DEPRECATED : prepare_notification_1 is an alias for send_notification. Exists only for backward compatibility - do not use - use send_notification instead.

argus_api.lib.notifications.v1.notification.send_notification(notificationID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Send a pending notification (INTERNAL)

Parameters

  • notificationID (str) – Notification ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON