BEbenchling
Event Subscription

Get EventSubscription by ID

Get a single EventSubscription by ID.

get/api/v3/event-subscription/{event_subscription_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

event_subscription_idstring required

ID of the EventSubscription.

Query parameters

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

Response

OK

__typenamestring
awsRegionstring nullable

The AWS region of the eventbridge subscription.

createdAtstring datetime nullable
destinationAddressstring nullable

The AWS ARN of the EventBridge event bus that Benchling will deliver events to.

destinationMetadataEventSubscriptionDestinationMetadata

Semi-structured metadata used for routing events.

destinationType'EVENTBRIDGE'
eventBusNamestring nullable

The name of the event bus of the eventbridge subscription .

expiresAtstring datetime nullable

The time after which the event subscription expires and will be paused.

idstring
modifiedAtstring datetime nullable
pausedboolean nullable

Indicates whether the event subscription is paused. Paused event subscriptions will not emit events to the configured destination.

Changes

No recorded changes to this operation across all 1 revision of this API.