---
title: "List Integration Events"
url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/operations/list-integration-events"
---

> Full API specification: https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8.md

# List Integration Events

`GET` `/integration-events`

Operation ID: `list-integration-events`

Returns a paginated collection of integration events.

## Query parameters

- `page` (object, optional) - Determines which page of the collection to retrieve.
- `filter` (object, optional) - Filters a collection of integration events.
- `sort` (string, optional) - Sorts a collection of integration events. Supported sort attributes are: - ts

## Responses

- `200` - A Paginated list response for a collection of integration events.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.3.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
paths:
  /integration-events:
    get:
      x-unstable: true
      x-internal: true
      summary: List Integration Events
      operationId: list-integration-events
      description: Returns a paginated collection of integration events.
      responses:
        "200":
          $ref: "#/components/responses/ListIntegrationEventsResponse"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      parameters:
        - $ref: "#/components/parameters/CursorPageQuery"
        - $ref: "#/components/parameters/IntegrationEventsFilter"
        - $ref: "#/components/parameters/IntegrationEventsSort"
      tags:
        - Integration Events
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  responses:
    ListIntegrationEventsResponse:
      description: A Paginated list response for a collection of integration events.
      content:
        application/json:
          schema:
            type: object
            additionalProperties: false
            properties:
              meta:
                $ref: "#/components/schemas/CursorMeta"
              data:
                type: array
                items:
                  $ref: "#/components/schemas/IntegrationEvent"
            required:
              - meta
              - data
          examples:
            Integration Events:
              $ref: "#/components/examples/ListIntegrationEventsResponse"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
  parameters:
    CursorPageQuery:
      name: page
      description: Determines which page of the collection to retrieve.
      required: false
      in: query
      schema:
        $ref: "#/components/schemas/CursorPageParameters"
    IntegrationEventsFilter:
      name: filter
      description: Filters a collection of integration events.
      required: false
      in: query
      style: deepObject
      schema:
        $ref: "#/components/schemas/IntegrationEventsFilterParameters"
    IntegrationEventsSort:
      name: sort
      description: |
        Sorts a collection of integration events. Supported sort attributes are:
          - ts
      required: false
      in: query
      schema:
        $ref: "#/components/schemas/SortQuery"
  schemas:
    CursorMeta:
      type: object
      description: Pagination metadata.
      required:
        - page
      properties:
        page:
          $ref: "#/components/schemas/CursorMetaPage"
    IntegrationEvent:
      title: IntegrationEvent
      type: object
      description: Event on a resource binding for an integration.
      additionalProperties: false
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the integration event.
          example: a90c4c20-bbd3-4229-8340-8b18e38cb1e5
          readOnly: true
        type:
          type: string
          description: Type of the integration event.
          example: incident.triggered
        ts:
          type: string
          format: date-time
          description: Date the integration event occurred at.
          example: 2024-01-01T00:00:00Z
        service_id:
          type: string
          format: uuid
          description: Identifier of the service the integration event corresponds to.
          example: b268ca70-9b75-4355-8726-63788463a66f
          readOnly: true
        deduplication_id:
          type: string
          description: Idempotent processing identifier of the integration event on
            ingestion.
          example: 1d34191ebfe305a56bf4f3303d1a8dcf
        resource_id:
          type: string
          description: Identifier of the resource the integration event corresponds to.
          example: 8_l-yZ8UQtc_e6Pp
        actor:
          $ref: "#/components/schemas/IntegrationEventActor"
        attributes:
          type: object
          description: Additional attributes of the integration event, specific to the
            binding resource and integration.
          additionalProperties: true
          example:
            service_id: PLK33TY
            incident_id: PGR0VU2
            escalation_policy_id: P005NFS
            priority_id: P9BO35Z
            urgency: low
            title: Example API Service Incident
            html_url: https://acme.pagerduty.com/incidents/PGR0VU2
        integration:
          $ref: "#/components/schemas/IntegrationRef"
        binding:
          type: string
          description: Binding resource the integration event corresponds to.
          example: pagerduty_service
        detail:
          type: string
          nullable: true
          description: Additional detail about the integration event.
          example: Example API Service Incident
        link_html:
          type: string
          nullable: true
          description: URL to the web-page for the source of the integration event.
          example: https://acme.pagerduty.com/incidents/PGR0VU2
      required:
        - id
        - type
        - ts
        - service_id
        - deduplication_id
        - resource_id
        - actor
        - attributes
        - integration
        - binding
        - detail
        - link_html
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    CursorPageParameters:
      type: object
      properties:
        size:
          type: integer
          description: The number of items included per page.
          example: 10
        after:
          type: string
          description: Cursor param specifying the page (i.e. the next page) of data
            returned.
          example: ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
        before:
          type: string
          description: Cursor param specifying the page (i.e. the previous page) of data
            returned.
          example: ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
    IntegrationEventsFilterParameters:
      title: IntegrationEventsFilterParameters
      type: object
      additionalProperties: false
      allOf:
        - $ref: "#/components/schemas/BaseServiceEventsFilterParameters"
        - type: object
          properties:
            service_id:
              $ref: "#/components/schemas/StringFieldFilter"
    SortQuery:
      title: SortQuery
      type: string
      example: created_at desc
      description: >
        The `asc` suffix is optional as the default sort order is ascending.

        The `desc` suffix is used to specify a descending order.

        Multiple sort attributes may be provided via a comma separated list.

        JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar
        desc').
    CursorMetaPage:
      type: object
      required:
        - size
        - next
        - previous
      properties:
        first:
          description: URI to the first page
          type: string
          format: path
        last:
          description: URI to the last page
          type: string
          format: path
        next:
          description: URI to the next page
          type: string
          format: path
          nullable: true
        previous:
          description: URI to the previous page
          type: string
          format: path
          nullable: true
        size:
          description: Requested page size
          type: number
          example: 10
    IntegrationEventActor:
      title: Integration Event Actor
      type: object
      description: >
        Information about the entity that triggered the integration event in the
        external system.
      additionalProperties: false
      nullable: true
      properties:
        type:
          type: string
          nullable: true
          description: Type of the entity that triggered the integration event in the
            external system.
          example: user
        id:
          type: string
          description: Identifier of the entity that triggered the integration event in
            the external system.
          example: PLH1HKV
        name:
          type: string
          nullable: true
          description: Name of the entity that triggered the integration event in the
            external system.
          example: John Doe
      required:
        - type
        - id
    IntegrationRef:
      type: object
      description: Short-hand descriptor of an integration installed within the catalog.
      required:
        - name
        - display_name
        - instance
      properties:
        name:
          type: string
          example: gateway-manager
        display_name:
          type: string
          example: gateway-manager
        instance:
          $ref: "#/components/schemas/IntegrationInstanceRef"
    BaseError:
      type: object
      title: Error
      description: standard error
      required:
        - status
        - title
        - instance
        - detail
      properties:
        status:
          type: integer
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          readOnly: true
        title:
          type: string
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          readOnly: true
        type:
          type: string
          description: The error type.
          readOnly: true
        instance:
          type: string
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          readOnly: true
        detail:
          type: string
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          readOnly: true
    InvalidParameters:
      type: array
      nullable: false
      uniqueItems: true
      minItems: 1
      description: invalid parameters
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
    BaseServiceEventsFilterParameters:
      title: BaseServiceEventsFilterParameters
      type: object
      properties:
        type:
          $ref: "#/components/schemas/StringFieldFilter"
        ts:
          $ref: "#/components/schemas/DateTimeFieldFilter"
        integration.name:
          oneOf:
            - $ref: "#/components/schemas/StringFieldFilter"
        integration.instance.id:
          oneOf:
            - $ref: "#/components/schemas/StringFieldFilterExact"
        integration.instance.name:
          oneOf:
            - $ref: "#/components/schemas/StringFieldFilter"
        integration.instance.display_name:
          oneOf:
            - $ref: "#/components/schemas/StringFieldFilter"
        binding:
          $ref: "#/components/schemas/StringFieldFilterExact"
        attributes:
          $ref: "#/components/schemas/EventsAttributesFieldFilter"
        detail:
          $ref: "#/components/schemas/StringFieldFilter"
        actor.type:
          oneOf:
            - $ref: "#/components/schemas/StringFieldFilter"
        actor.id:
          oneOf:
            - $ref: "#/components/schemas/StringFieldFilter"
        actor.name:
          oneOf:
            - $ref: "#/components/schemas/StringFieldFilter"
    StringFieldFilter:
      oneOf:
        - title: Filter by operator
          description: "Filter using **one** of the following operators: `eq`, `oeq`,
            `neq`, `contains`, `ocontains`"
          x-examples:
            example-1:
              contains: some-value
              ocontains: this-value,or-that-value
              oeq: some-value,some-other-value
              neq: not-this-value
            example-2:
              eq: some-value
          properties:
            eq:
              type: string
              description: The field exactly matches the provided value.
              example: ?filter[field_name_here][eq]=foo
            contains:
              type: string
              description: The field contains the provided value.
              example: ?filter[field_name_here][contains]=foo
            ocontains:
              type: string
              description: The field contains any of the provided values.
              example: ?filter[field_name_here][ocontains]=foo,bar
            oeq:
              type: string
              description: The field matches any of the provided values.
              example: ?filter[field_name_here][oeq]=foo,bar
            neq:
              type: string
              description: The field does not match the provided value.
              example: ?filter[field_name_here][neq]=bar
          type: object
          additionalProperties: false
        - title: Filter by exact string match
          type: string
          description: The field exactly matches the provided value.
          example: ?filter[title]=foo
    IntegrationInstanceRef:
      type: object
      description: Short-hand descriptor of an integration instance.
      required:
        - id
        - name
        - display_name
      properties:
        id:
          type: string
          format: uuid
          example: 772b9caf-ddbc-4f4f-8aa4-8dfbbe420351
          description: The integration instance ID.
        name:
          type: string
          description: >
            The machine name of the integration instance that uniquely
            identifies it within the catalog.
          pattern: ^[0-9a-z.-]+$
          example: aws-lambda-prod
        display_name:
          type: string
          description: The display name of the integration instance.
          example: AWS (prod)
    InvalidParameterStandard:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          readOnly: true
          nullable: false
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          readOnly: true
          nullable: false
          enum:
            - max_length
            - max_items
            - max
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          readOnly: true
          nullable: false
          enum:
            - enum
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          uniqueItems: true
          readOnly: true
          nullable: false
          minItems: 1
          items: {}
        source:
          type: string
          example: body
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          readOnly: true
          nullable: true
          enum:
            - dependent_fields
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          uniqueItems: true
          nullable: true
          items: {}
          readOnly: true
        source:
          type: string
          example: body
      required:
        - field
        - rule
        - reason
        - dependents
    DateTimeFieldFilter:
      title: DateTimeFieldFilter
      description: Filters on the given datetime (RFC-3339) field value.
      oneOf:
        - type: string
          title: DateTimeFieldImplicitEqualsFilter
          format: date-time
          description: Value strictly equals given RFC-3339 formatted timestamp in UTC
          example: 2022-03-30T07:20:50Z
        - type: object
          title: DateTimeFieldEqualsFilter
          additionalProperties: false
          properties:
            eq:
              type: string
              format: date-time
              description: Value strictly equals given RFC-3339 formatted timestamp in UTC
              example: 2022-03-30T07:20:50Z
          required:
            - eq
        - type: object
          title: DateTimeFieldLTFilter
          additionalProperties: false
          properties:
            lt:
              type: string
              format: date-time
              description: Value is less than the given RFC-3339 formatted timestamp in UTC
              example: 2022-03-30T07:20:50Z
          required:
            - lt
        - type: object
          title: DateTimeFieldLTEFilter
          additionalProperties: false
          properties:
            lte:
              type: string
              format: date-time
              description: Value is less than or equal to the given RFC-3339 formatted
                timestamp in UTC
              example: 2022-03-30T07:20:50Z
          required:
            - lte
        - type: object
          title: DateTimeFieldGTFilter
          additionalProperties: false
          properties:
            lt:
              type: string
              format: date-time
              description: Value is greater than the given RFC-3339 formatted timestamp in UTC
              example: 2022-03-30T07:20:50Z
          required:
            - gt
        - type: object
          title: DateTimeFieldGTEFilter
          additionalProperties: false
          properties:
            lte:
              type: string
              format: date-time
              description: Value is greater than or equal to the given RFC-3339 formatted
                timestamp in UTC
              example: 2022-03-30T07:20:50Z
          required:
            - gte
      x-examples:
        datetime_field_1: 2022-03-30T07:20:50Z
        datetime_field_2:
          eq: 2022-03-30T07:20:50Z
        datetime_field_3:
          lt: 2022-03-30T07:20:50Z
        datetime_field_4:
          lte: 2022-03-30T07:20:50Z
        datetime_field_5:
          gt: 2022-03-30T07:20:50Z
        datetime_field_6:
          gte: 2022-03-30T07:20:50Z
    StringFieldFilterExact:
      description: "Filter using **one** of the following operators: `eq`, `oeq`, `neq`"
      x-examples:
        example-1:
          oeq: some-value,some-other-value
          neq: not-this-value
        example-2:
          eq: some-value
      properties:
        eq:
          type: string
          description: The field exactly matches the provided value.
          example: ?filter[field_name_here][eq]=foo
        oeq:
          type: string
          description: The field matches any of the provided values.
          example: ?filter[field_name_here][oeq]=foo,bar
        neq:
          type: string
          description: The field does not match the provided value.
          example: ?filter[field_name_here][neq]=bar
      type: object
      additionalProperties: false
    EventsAttributesFieldFilter:
      title: EventsAttributesFieldFilter
      description: >
        Filters the events by values contained within the `attributes` field.
        Filters must use dot-notation to identify

        the details property that will be used to filter the results.
      oneOf:
        - $ref: "#/components/schemas/StringFieldFilter"
    InvalidRules:
      description: invalid parameters rules
      type: string
      readOnly: true
      nullable: true
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
  examples:
    ListIntegrationEventsResponse:
      value:
        data:
          - id: 123e4567-e89b-12d3-a456-426614174000
            type: incident.triggered
            ts: 2024-01-01T00:00:00Z
            service_id: b268ca70-9b75-4355-8726-63788463a66f
            deduplication_id: 1d34191ebfe305a56bf4f3303d1a8dcf
            resource_id: 8_l-yZ8UQtc_e6Pp
            actor:
              type: user
              id: PLH1HKV
              name: John Doe
            attributes:
              service_id: PLK33TY
              incident_id: PGR0VU2
              escalation_policy_id: P005NFS
              priority_id: P9BO35Z
              urgency: low
              title: Example API Service Incident
              html_url: https://acme.pagerduty.com/incidents/PGR0VU2
            integration:
              name: gateway-manager
              display_name: Gateway Manager
              instance:
                id: 9de3f4dd-41bc-4844-a38b-de74eb6ed002
                name: gateway-manager
                display_name: Gateway Manager
            binding: pagerduty_service
            detail: Example API Service Incident
            link_html: https://acme.pagerduty.com/incidents/PGR0VU2
        meta:
          page:
            size: 1
            next: /v1/integration-events?page[size]=2&page[after]=CChwKiIxLSBscUg9KisFRwtOBVVBQ1pTPh8kIhVWHGwmFkA1ERxaLlMuRSEDf3sBcBRmfmJ6ZmZyEH98UGpsdFQEQBhiDW9DC10qTyYuAhhCbHhRWjIRHFo3QCZVNgN_e1IzRXF_cDoqODQhbHFIbzl8M34tYBJrQCkCA2Y7DWUaKQ
            previous: null
            first: /v1/integration-events?page[size]=2
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```