Manage Integration Event
Updates, gets, and deletes an integration event.
Path Parameters
- tenantId
Describes the tenantId of the tenant
- installedIntgId
Unique Identifier of the installed integration
- eventId
The unique ID of an event related to the integration
Responses
- id
- name
Name of the Integration event.
- entity
Entity on which an action is performed. Supported entities include: Service Desk INCIDENT SERVICEREQUEST CHANGE PROBLEM TASK Resource Alert ALERT (used only when eventType is selected as NONE)
- eventType
Type of action performed on the entity. Supported values include: NONE (Used to invoke external integration through process workflow), CREATE, UPDATE, DELETE
- Enum:
- NONECREATEUPDATEDELETE
- notifier
The fields are required unless specific to an `authType`.
- endPointURI
- headers
- thirdPartyEventType
Type of action performed on the entity.Supported Values: POST, PUT, GET, DELETE, and PATCH
- Enum:
- POSTPUTGETDELETEPATCH
- payload
Third-party integration event payload. Provide the third-party payload with OpsRamp placeholders to integrate the event between OpsRamp and third-party: - To get OpsRamp tokens, use refer to the Get Integration Event Placeholders API. - Convert the payload to base 64 and provide the file in the field file in the below sample request.
- filterCriteria
Filter entities on which the event is added to the rules
- useBaseNotifier
Notification details to trigger events defined. To configure integration base notifier: - Provide useBaseNotifier: true to assign the notifier details to the event. - Provide useBaseNotifier: false to assign different notifier details
- responseHeaders
- depEvent
Path Parameters
- tenantId
Describes the tenantId of the tenant
- installedIntgId
Unique Identifier of the installed integration
- eventId
The unique ID of an event related to the integration
Request Body
application/json
- id
- name
Name of the Integration event.
- entity
Entity on which an action is performed. Supported entities include: Service Desk INCIDENT SERVICEREQUEST CHANGE PROBLEM TASK Resource Alert ALERT (used only when eventType is selected as NONE)
- eventType
Type of action performed on the entity. Supported values include: NONE (Used to invoke external integration through process workflow), CREATE, UPDATE, DELETE
- Enum:
- NONECREATEUPDATEDELETE
- notifier
The fields are required unless specific to an `authType`.
- endPointURI
- headers
- thirdPartyEventType
Type of action performed on the entity.Supported Values: POST, PUT, GET, DELETE, and PATCH
- Enum:
- POSTPUTGETDELETEPATCH
- payload
Third-party integration event payload. Provide the third-party payload with OpsRamp placeholders to integrate the event between OpsRamp and third-party: - To get OpsRamp tokens, use refer to the Get Integration Event Placeholders API. - Convert the payload to base 64 and provide the file in the field file in the below sample request.
- filterCriteria
Filter entities on which the event is added to the rules
- useBaseNotifier
Notification details to trigger events defined. To configure integration base notifier: - Provide useBaseNotifier: true to assign the notifier details to the event. - Provide useBaseNotifier: false to assign different notifier details
- responseHeaders
- depEvent
Responses
- id
- name
Name of the Integration event.
- entity
Entity on which an action is performed. Supported entities include: Service Desk INCIDENT SERVICEREQUEST CHANGE PROBLEM TASK Resource Alert ALERT (used only when eventType is selected as NONE)
- eventType
Type of action performed on the entity. Supported values include: NONE (Used to invoke external integration through process workflow), CREATE, UPDATE, DELETE
- Enum:
- NONECREATEUPDATEDELETE
- notifier
The fields are required unless specific to an `authType`.
- endPointURI
- headers
- thirdPartyEventType
Type of action performed on the entity.Supported Values: POST, PUT, GET, DELETE, and PATCH
- Enum:
- POSTPUTGETDELETEPATCH
- payload
Third-party integration event payload. Provide the third-party payload with OpsRamp placeholders to integrate the event between OpsRamp and third-party: - To get OpsRamp tokens, use refer to the Get Integration Event Placeholders API. - Convert the payload to base 64 and provide the file in the field file in the below sample request.
- filterCriteria
Filter entities on which the event is added to the rules
- useBaseNotifier
Notification details to trigger events defined. To configure integration base notifier: - Provide useBaseNotifier: true to assign the notifier details to the event. - Provide useBaseNotifier: false to assign different notifier details
- responseHeaders
- depEvent
Path Parameters
- tenantId
Describes the tenantId of the tenant
- installedIntgId
Unique Identifier of the installed integration
- eventId
The unique ID of an event related to the integration