---
title: "IntegrationEvent"
url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/schemas/IntegrationEvent"
---

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

# IntegrationEvent

Event on a resource binding for an integration.

## 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
components:
  schemas:
    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"
    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)
    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
```