> ## Documentation Index
> Fetch the complete documentation index at: https://docs.membrane.agency/llms.txt
> Use this file to discover all available pages before exploring further.

# list-external-event-subscriptions

> List external event subscriptions — each is a live hook that subscribes a connection (or just code) to an external event type and delivers matching events to routines. Filter by connection, integration, event type, tenant, or status.



## OpenAPI

````yaml /api-reference/membrane-api.json get /external-event-subscriptions
openapi: 3.0.0
info:
  title: Membrane API
  description: API documentation for Membrane Engine
  version: '1.0'
  contact: {}
servers:
  - url: https://api.getmembrane.com
security:
  - bearer: []
tags: []
paths:
  /external-event-subscriptions:
    get:
      summary: list-external-event-subscriptions
      description: >-
        List external event subscriptions — each is a live hook that subscribes
        a connection (or just code) to an external event type and delivers
        matching events to routines. Filter by connection, integration, event
        type, tenant, or status.
      operationId: listExternalEventSubscriptions
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            description: Maximum number of items to return (1-1000)
            type: integer
            minimum: 1
            maximum: 1000
        - name: cursor
          in: query
          required: false
          schema:
            description: Pagination cursor from a previous response
            type: string
        - name: includeArchived
          in: query
          required: false
          schema:
            type: boolean
        - name: tenantId
          in: query
          required: false
          schema:
            type: string
        - name: userId
          in: query
          required: false
          schema:
            type: string
        - name: connectionId
          in: query
          required: false
          schema:
            type: string
        - name: integrationId
          in: query
          required: false
          schema:
            type: string
        - name: externalAppId
          in: query
          required: false
          schema:
            type: string
        - name: externalEventTypeId
          in: query
          required: false
          schema:
            type: string
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - subscribed
              - unsubscribed
              - error
      responses:
        '200':
          description: >-
            List external event subscriptions — each is a live hook that
            subscribes a connection (or just code) to an external event type and
            delivers matching events to routines. Filter by connection,
            integration, event type, tenant, or status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        userId:
                          type: string
                        tenantId:
                          type: string
                        ownerName:
                          type: string
                          nullable: true
                        id:
                          type: string
                        name:
                          type: string
                        description:
                          type: string
                        connectionId:
                          type: string
                        integrationId:
                          type: string
                        externalEventTypeId:
                          type: string
                        config:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - data-record-created
                                - data-record-updated
                                - data-record-deleted
                                - connector-event
                            dataSource:
                              type: object
                              properties:
                                key: {}
                                collectionKey: {}
                                collectionParameters: {}
                                pullUpdatesIntervalSeconds:
                                  type: number
                                fullSyncIntervalSeconds:
                                  type: number
                              additionalProperties: false
                            eventKey:
                              type: string
                            eventParameters: {}
                          required:
                            - type
                          additionalProperties: false
                        status:
                          type: string
                          enum:
                            - subscribed
                            - unsubscribed
                            - error
                        error:
                          allOf:
                            - type: object
                        state:
                          type: string
                          enum:
                            - BUILDING
                            - CLIENT_ACTION_REQUIRED
                            - CONFIGURATION_ERROR
                            - SETUP_FAILED
                            - READY
                            - DISCONNECTING
                        buildingAgentSessionId:
                          type: string
                        isRealTime:
                          type: boolean
                        requiresPull:
                          type: boolean
                        requiresFullSync:
                          type: boolean
                        createdAt:
                          type: string
                        archivedAt:
                          type: string
                        isDeactivated:
                          type: boolean
                        stateData: {}
                        nextPullEventsTimestamp:
                          type: number
                        pullUpdatesIntervalSeconds:
                          type: number
                        fullSyncIntervalSeconds:
                          type: number
                        nextRefreshTimestamp:
                          type: number
                        incomingWebhookUri:
                          type: string
                        subscribedWebhookUri:
                          type: string
                        lastReceivedAt: {}
                        lastEventAt: {}
                        webhookUri:
                          type: string
                        logoUri:
                          description: >-
                            Resolved app logo for this element (integration ->
                            connector -> external app -> favicon).
                          type: string
                      required:
                        - userId
                        - id
                      additionalProperties: false
                  cursor:
                    type: string
                required:
                  - items
                additionalProperties: false
components:
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````