Event Destinations

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

class ngrok.services.EventDestinationsClient(client)[source]
create(metadata='', description='', format='', target=None)[source]

Create a new Event Destination. It will not apply to anything until it is associated with an Event Stream, and that Event Stream is associated with an Endpoint Config.

Parameters
  • metadata (str) – Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.

  • description (str) – Human-readable description of the Event Destination. Optional, max 255 bytes.

  • format (str) – The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.

  • target (Optional[EventTarget]) – An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.

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

Return type

EventDestination

delete(id)[source]

Delete an Event Destination. If the Event Destination is still referenced by an Event Subscription.

Parameters

id (str) – a resource identifier

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

get(id)[source]

Get detailed information about an Event Destination by ID.

Parameters

id (str) – a resource identifier

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

Return type

EventDestination

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

List all Event Destinations on this account.

Parameters
  • before_id (Optional[str]) –

  • limit (Optional[str]) –

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

Return type

EventDestinationList

update(id, metadata=None, description=None, format=None, target=None)[source]

Update attributes of an Event Destination.

Parameters
  • id (str) – Unique identifier for this Event Destination.

  • metadata (Optional[str]) – Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.

  • description (Optional[str]) – Human-readable description of the Event Destination. Optional, max 255 bytes.

  • format (Optional[str]) – The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.

  • target (Optional[EventTarget]) – An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.

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

Return type

EventDestination