Skip to content

Commit 7aa40b7

Browse files
committed
add docstring to notifications fcn
1 parent 281a12f commit 7aa40b7

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

planet/subscription_request.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,16 @@ def oracle_cloud_storage(customer_access_key_id: str,
258258

259259

260260
def notifications(url: str, topics: List[str]) -> dict:
261+
'''Specify a subscriptions API notification.
262+
263+
Webhook notifications proactively notify you when a subscription matches
264+
and delivers an item so you have confidence that you have all the expected
265+
imagery.
266+
267+
Parameters:
268+
url: location of webhook/callback where you expect to receive updates.
269+
topics: Event types that you can choose to be notified about.
270+
'''
261271
for i, t in enumerate(topics):
262272
try:
263273
topics[i] = specs.get_match(t, NOTIFICATIONS_TOPICS, 'topic')

0 commit comments

Comments
 (0)