Search
K
Konnect Service Catalog

IntegrationEvent

object

Event on a resource binding for an integration.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Unique identifier of the integration event.

Example:a90c4c20-bbd3-4229-8340-8b18e38cb1e5

typestringrequired

Type of the integration event.

Example:incident.triggered

tsstring(date-time)required

Date the integration event occurred at.

Example:2024-01-01T00:00:00Z

service_idstring(uuid)requiredread-only

Identifier of the service the integration event corresponds to.

Example:b268ca70-9b75-4355-8726-63788463a66f

deduplication_idstringrequired

Idempotent processing identifier of the integration event on ingestion.

Example:1d34191ebfe305a56bf4f3303d1a8dcf

resource_idstringrequired

Identifier of the resource the integration event corresponds to.

Example:8_l-yZ8UQtc_e6Pp

actorobjectrequired

Information about the entity that triggered the integration event in the external system.

* Additional properties are NOT allowed.
Show Child Parameters
attributesobjectrequired

Additional attributes of the integration event, specific to the binding resource and integration.

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"}

* Additional properties are allowed.
integrationobjectrequired

Short-hand descriptor of an integration installed within the catalog.

Show Child Parameters
bindingstringrequired

Binding resource the integration event corresponds to.

Example:pagerduty_service

detailstringrequired

Additional detail about the integration event.

Example:Example API Service Incident

link_htmlstringrequired

URL to the web-page for the source of the integration event.

Example:https://acme.pagerduty.com/incidents/PGR0VU2

Example

CreateIntegrationEvent

object

DTO object for creating an integration event for an integration. type and binding are parameters restricted by the
integration the event is being created for, found in the related integration manifest.

* Additional properties are NOT allowed.
typestringrequired

Type of the event.

Example:incident.triggered

tsstring(date-time)required

Date the event occurred at.

Example:2024-01-01T00:00:00Z

deduplication_idstringrequired

Idempotent processing identifier of the event on ingestion.

Example:1d34191ebfe305a56bf4f3303d1a8dcf

actorobjectrequired

Information about the entity that triggered the integration event in the external system.

* Additional properties are NOT allowed.
Show Child Parameters
attributesobjectrequired

Additional attributes of the event, specific to the binding resource and integration.

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"}

* Additional properties are allowed.
dataobjectrequired

JSON object containing the data which binds the integration to a service. Must match the schema defined for
the integration binding, referenced by the binding parameter.

Example:{"pagerduty_service_id":"PLK33TY"}

* Additional properties are allowed.
bindingstringrequired

Binding resource the event corresponds to.

Example:pagerduty_service

detailstringrequired

Additional detail about the event.

Example:Example API Service Incident

link_htmlstringrequired

URL to the web-page for the source of the event.

Example:https://acme.pagerduty.com/incidents/PGR0VU2

Example

DocumentContentTypeEnum

string

Determines if response should be in JSON format or a document tree

Allowed values:application/jsonapplication/vnd.konnect.document-tree+json

Default:application/json

DocumentFormatContentTypeEnum

string

Allowed values:application/json

Default:application/json

SuggestedResourceAction

One Of
typestringrequired

Allowed values:archive

Example