Notifications

class Notifications(session_kwargs, client, return_type='raw')

Civis API /notifications endpoint:

import civis
client = civis.APIClient()
# Call client.notifications.<method>(<arguments>) to make a request, e.g.:
client.notifications.get(...)

Methods

`get`(*[, last_event_id, r, mock])	Receive a stream of notifications as they come in
`list`(*[, last_event_id, r, mock])	Receive a stream of notifications as they come in

get(*, last_event_id: str = None, r: str = None, mock: str = None) → Response

Receive a stream of notifications as they come in

API URL: GET /notifications

Parameters:

last_event_idstr, optional: allows browser to keep track of last event fired
rstr, optional: specifies retry/reconnect timeout
mockstr, optional: used for testing

Returns:

None: Response code 200: success

list(*, last_event_id: str = None, r: str = None, mock: str = None) → ListResponse

Receive a stream of notifications as they come in

API URL: GET /notifications

Warning

The method name <client>.notifications.list is deprecated and will be removed at civis-python v3.0.0 (no release timeline yet). Please switch to <client>.notifications.get for the same method.

Parameters:

last_event_idstr, optional: allows browser to keep track of last event fired
rstr, optional: specifies retry/reconnect timeout
mockstr, optional: used for testing

Returns:

None: Response code 200: success