Skip to main content
Server path: /ngrok-events | Type: Application | PCID required: Yes

Tools


ngrok_events_event_destinations_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoHuman-readable description of the Event Destination. Optional, max 255 bytes.
formatstringNoThe output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
metadatastringNoArbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
targetobjectNoThe target value

ngrok_events_event_destinations_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_events_event_destinations_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_events_event_destinations_list

List Parameters:
ParameterTypeRequiredDefaultDescription
before_idstringNoExpects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
limitstringNoConstrains the number of results in the dataset. See the API Overview for details.
filterstringNoA CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

ngrok_events_event_destinations_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier for this Event Destination.
descriptionstringNoHuman-readable description of the Event Destination. Optional, max 255 bytes.
formatstringNoThe output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
metadatastringNoArbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
targetobjectNoThe target value

ngrok_events_event_sources_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
subscription_idstringYesThe unique identifier for the Event Subscription that this Event Source is attached to.
typestringNoType of event for which an event subscription will trigger

ngrok_events_event_sources_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
subscription_idstringYesThe unique identifier for the Event Subscription that this Event Source is attached to.
typestringYesType of event for which an event subscription will trigger

ngrok_events_event_sources_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
subscription_idstringYesThe unique identifier for the Event Subscription that this Event Source is attached to.
typestringYesType of event for which an event subscription will trigger

ngrok_events_event_sources_list

List Parameters:
ParameterTypeRequiredDefaultDescription
subscription_idstringYesThe unique identifier for the Event Subscription that this Event Source is attached to.

ngrok_events_event_sources_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
subscription_idstringYesThe unique identifier for the Event Subscription that this Event Source is attached to.
typestringYesType of event for which an event subscription will trigger

ngrok_events_event_subscriptions_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoArbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
destination_idsstring[]NoA list of Event Destination IDs which should be used for this Event Subscription.
metadatastringNoArbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
sourcesobject[]NoSources containing the types for which this event subscription will trigger

ngrok_events_event_subscriptions_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_events_event_subscriptions_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_events_event_subscriptions_list

List Parameters:
ParameterTypeRequiredDefaultDescription
before_idstringNoExpects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
limitstringNoConstrains the number of results in the dataset. See the API Overview for details.
filterstringNoA CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

ngrok_events_event_subscriptions_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier for this Event Subscription.
descriptionstringNoArbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
destination_idsstring[]NoA list of Event Destination IDs which should be used for this Event Subscription.
metadatastringNoArbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
sourcesobject[]NoSources containing the types for which this event subscription will trigger

ngrok_events_secrets_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNodescription of Secret
metadatastringNoArbitrary user-defined metadata for this Secret
namestringNoName of secret
valuestringNoValue of secret
vault_idstringNounique identifier of the referenced vault
vault_namestringNoname of the referenced vault

ngrok_events_secrets_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_events_secrets_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_events_secrets_list

List Parameters:
ParameterTypeRequiredDefaultDescription
before_idstringNoExpects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
limitstringNoConstrains the number of results in the dataset. See the API Overview for details.
filterstringNoA CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

ngrok_events_secrets_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesidentifier for Secret
descriptionstringNodescription of Secret
metadatastringNoArbitrary user-defined metadata for this Secret
namestringNoName of secret
valuestringNoValue of secret

ngrok_events_vaults_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNodescription of Vault
metadatastringNoArbitrary user-defined metadata for this Vault
namestringNoName of vault

ngrok_events_vaults_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_events_vaults_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_events_vaults_get_secrets_by_vault

GetSecretsByVault Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier
before_idstringNoBefore Id
limitstringNoMaximum number of results to return

ngrok_events_vaults_list

List Parameters:
ParameterTypeRequiredDefaultDescription
before_idstringNoExpects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
limitstringNoConstrains the number of results in the dataset. See the API Overview for details.
filterstringNoA CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

ngrok_events_vaults_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesidentifier for Vault
descriptionstringNodescription of Vault
metadatastringNoArbitrary user-defined metadata for this Vault
namestringNoName of vault