Event Sources#

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

class ngrok.services.EventSourcesClient(client)[source]#
create(subscription_id, type='')[source]#

Add an additional type for which this event subscription will trigger

Parameters:

  • subscription_id (str) – The unique identifier for the Event Subscription that this Event Source is attached to.

  • type (str) – Type of event for which an event subscription will trigger

https://ngrok.com/docs/api#api-event-sources-create

Return type:

EventSource

delete(subscription_id, type)[source]#

Remove a type for which this event subscription will trigger

Parameters:

  • subscription_id (str) – The unique identifier for the Event Subscription that this Event Source is attached to.

  • type (str) – Type of event for which an event subscription will trigger

https://ngrok.com/docs/api#api-event-sources-delete

get(subscription_id, type)[source]#

Get the details for a given type that triggers for the given event subscription

Parameters:

  • subscription_id (str) – The unique identifier for the Event Subscription that this Event Source is attached to.

  • type (str) – Type of event for which an event subscription will trigger

https://ngrok.com/docs/api#api-event-sources-get

Return type:

EventSource

list(subscription_id)[source]#

List the types for which this event subscription will trigger

Parameters:

subscription_id (str) – The unique identifier for the Event Subscription that this Event Source is attached to.

https://ngrok.com/docs/api#api-event-sources-list

Return type:

EventSourceList

update(subscription_id, type)[source]#

Update the type for which this event subscription will trigger

Parameters:

  • subscription_id (str) – The unique identifier for the Event Subscription that this Event Source is attached to.

  • type (str) – Type of event for which an event subscription will trigger

https://ngrok.com/docs/api#api-event-sources-update

Return type:

EventSource