Event Subscriptions¶

Do not construct this object directly, instead access the event_subscriptions property of an ngrok.Client object.

class ngrok.services.EventSubscriptionsClient(client)[source]¶

create(metadata='', description='', sources=[], destination_ids=[])[source]¶

Create an Event Subscription.

Parameters

metadata (str) – Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
description (str) – Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
sources (Sequence[EventSourceReplace]) – Sources containing the types for which this event subscription will trigger
destination_ids (Sequence[str]) – A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.

delete(id)[source]¶

Delete an Event Subscription.

Get an Event Subscription by ID.

list(before_id=None, limit=None)[source]¶

List this Account’s Event Subscriptions.

Parameters

update(id, metadata=None, description=None, sources=None, destination_ids=None)[source]¶

Update an Event Subscription.

Parameters

id (str) – Unique identifier for this Event Subscription.
metadata (Optional[str]) – Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
description (Optional[str]) – Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
sources (Optional[Sequence[EventSourceReplace]]) – Sources containing the types for which this event subscription will trigger
destination_ids (Optional[Sequence[str]]) – A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.