Benchling Event Subscription API

openapi: 3.2.0
info:
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  title: Benchling Event Subscription API
  version: 2.0.0
  description: 'Configures delivery of Benchling events to external systems via AWS EventBridge. Event

    subscriptions enable real-time integration by streaming events (such as entity creation,

    updates, or workflow state changes) to a customer''s AWS EventBridge event bus. The

    subscription includes the destination AWS ARN (see `destinationAddress`), routing metadata,

    and lifecycle management through expiration (see `expiresAt`) and pause controls. Paused

    subscriptions stop emitting events but retain their configuration for later resumption.

    Event subscriptions are typically managed through Benchling Apps (see `BenchlingApp`).'
servers:
- url: /api/v3
security:
- oAuth: []
- basicApiKeyAuth: []
tags:
- description: 'Configures delivery of Benchling events to external systems via AWS EventBridge. Event

    subscriptions enable real-time integration by streaming events (such as entity creation,

    updates, or workflow state changes) to a customer''s AWS EventBridge event bus. The

    subscription includes the destination AWS ARN (see `destinationAddress`), routing metadata,

    and lifecycle management through expiration (see `expiresAt`) and pause controls. Paused

    subscriptions stop emitting events but retain their configuration for later resumption.

    Event subscriptions are typically managed through Benchling Apps (see `BenchlingApp`).'
  name: EventSubscription
  x-bnch-organization: Benchling
paths:
  /event-subscription/items:
    get:
      description: List EventSubscription items.
      operationId: EventSubscription.List
      parameters:
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/returning'
      - description: 'Method by which to order results. Valid sorts are: modifiedAt (modified time, oldest first). Use :asc or :desc to specify ascending or descending order. Default is modifiedAt:desc.'
        in: query
        name: sort
        schema:
          default: modifiedAt:desc
          enum:
          - modifiedAt:asc
          - modifiedAt:desc
          type: string
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSubscriptionPaginatedList'
          description: OK
          headers: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: List EventSubscription items
      tags:
      - EventSubscription
      x-bnch-rate-limit-tier: 4
  /event-subscription/{event_subscription_id}:
    get:
      description: Get a single EventSubscription by ID.
      operationId: EventSubscription.Get
      parameters:
      - description: ID of the EventSubscription.
        in: path
        name: event_subscription_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSubscription'
          description: OK
          headers: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get EventSubscription by ID
      tags:
      - EventSubscription
      x-bnch-rate-limit-tier: 5
components:
  schemas:
    EventSubscription:
      description: 'Configures delivery of Benchling events to external systems via AWS EventBridge. Event

        subscriptions enable real-time integration by streaming events (such as entity creation,

        updates, or workflow state changes) to a customer''s AWS EventBridge event bus. The

        subscription includes the destination AWS ARN (see `destinationAddress`), routing metadata,

        and lifecycle management through expiration (see `expiresAt`) and pause controls. Paused

        subscriptions stop emitting events but retain their configuration for later resumption.

        Event subscriptions are typically managed through Benchling Apps (see `BenchlingApp`).'
      properties:
        __typename:
          type: string
        awsRegion:
          description: The AWS region of the eventbridge subscription.
          type:
          - 'null'
          - string
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        destinationAddress:
          description: The AWS ARN of the EventBridge event bus that Benchling will deliver events to.
          type:
          - 'null'
          - string
        destinationMetadata:
          description: Semi-structured metadata used for routing events.
          type:
          - 'null'
          - object
        destinationType:
          enum:
          - EVENTBRIDGE
          - null
          type:
          - 'null'
          - string
        eventBusName:
          description: The name of the event bus of the eventbridge subscription .
          type:
          - 'null'
          - string
        expiresAt:
          description: The time after which the event subscription expires and will be paused.
          format: datetime
          type:
          - 'null'
          - string
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        paused:
          description: 'Indicates whether the event subscription is paused.

            Paused event subscriptions will not emit events to the configured

            destination.'
          type:
          - 'null'
          - boolean
      type: object
    EventSubscriptionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/EventSubscription'
          type: array
        nextToken:
          type: string
      type: object
    InternalServerError:
      properties:
        detail:
          type:
          - 'null'
          - string
          - object
        errorId:
          type: string
        instance:
          type: string
        status:
          type: integer
        title:
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - type
      - title
      - detail
      - status
      - instance
      type: object
    GeneralError:
      properties:
        detail:
          type:
          - 'null'
          - string
          - object
        instance:
          type: string
        status:
          type: integer
        title:
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - type
      - title
      - detail
      - status
      - instance
      type: object
  parameters:
    modifiedAt.lte:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified at or before the specified time. e.g. <= 2017-04-30.
      in: query
      name: modifiedAt.lte
      schema:
        format: datetime
        type: string
    pageSize:
      description: Number of results to return. Defaults to 50, maximum of 100.
      in: query
      name: pageSize
      schema:
        type: integer
    returning:
      description: Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.
      explode: false
      in: query
      name: returning
      schema:
        items:
          type: string
        type: array
    id.anyOf:
      description: Restricts results to those matching any of the specified IDs. Comma-separated list.
      explode: false
      in: query
      name: id.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    omit:
      description: Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.
      explode: false
      in: query
      name: omit
      schema:
        items:
          type: string
        type: array
    modifiedAt.lt:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified before the specified time. e.g. < 2017-04-30.
      in: query
      name: modifiedAt.lt
      schema:
        format: datetime
        type: string
    nextToken:
      description: Token for pagination
      in: query
      name: nextToken
      schema:
        type: string
    modifiedAt.gt:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified after the specified time. e.g. > 2017-04-30.
      in: query
      name: modifiedAt.gt
      schema:
        format: datetime
        type: string
    modifiedAt.gte:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified at or after the specified time. e.g. >= 2017-04-30.
      in: query
      name: modifiedAt.gte
      schema:
        format: datetime
        type: string
  responses:
    NotFound:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Not Found
    TooManyRequests:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Too Many Requests
    BadRequest:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Bad Request
    Forbidden:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Forbidden
    InternalServerError:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
      description: Internal Server Error
  securitySchemes:
    basicApiKeyAuth:
      description: Use issued API key for standard access to the API
      scheme: basic
      type: http
    basicClientIdSecretAuth:
      description: Auth used as part of client credentials OAuth flow prior to receiving a bearer token.
      scheme: basic
      type: http
    oAuth:
      description: OAuth2 Client Credentials flow intended for service access
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: /oauth/token
      type: oauth2