diff --git a/api/push-gateway/push_notifier.yaml b/api/push-gateway/push_notifier.yaml index c4cb7f72..046a9745 100644 --- a/api/push-gateway/push_notifier.yaml +++ b/api/push-gateway/push_notifier.yaml @@ -22,12 +22,15 @@ paths: In either case it may contain numeric counts of the number of unread events of different types the user has. The counts may be sent along with a notification about an event or by themselves. + Notifications about a particular event will normally cause the user to be alerted in some way. It is therefore necessary to perform duplicate suppression for such notifications using the `event_id` field to avoid retries of this HTTP API causing duplicate alerts. The operation of - updating counts of unread notifications should be and therefore do not - require duplicate suppression. + updating counts of unread notifications should be idempotent and + therefore do not require duplicate suppression. + + *NB: Notifications are sent to the URL configured when the pusher is created. This means that the HTTP path may be different depending on the push gateway.*