Endpoint
/api/v2//tenants/{tenantId}/integrations/installed/{installedIntgId}/events
Path Parameters
tenantIdstring
installedIntgIdstring
Responses
OK
descendingOrderboolean
nextPageboolean
pageNointeger
pageSizeinteger
resultsarray
Child Parameters
- results.depEvent
- results.endPointURI
- results.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)
- results.eventType
- Type of action performed on the entity. Supported values include: NONE (Used to invoke external integration through process workflow), CREATE, UPDATE, DELETE
- results.filterCriteria
- (Optional) Filter entities on which the event is added to the rules:
- results.headers
- results.id
- results.name
- Name of the Integration event.
- results.notifier
- The fields are required unless specific to an `authType`.
- results.payload
- (Optional) 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.
- results.responseHeaders
- results.thirdPartyEventType
- Type of action performed on the entity.Supported Values: POST, PUT, GET, DELETE, and PATCH
- results.useBaseNotifier
- (Optional) 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
totalPagesinteger
totalResultsinteger
{
"descendingOrder": false,
"nextPage": false,
"pageNo": 1,
"pageSize": 100,
"results": [
{
"entity": "INCIDENT",
"headers": [
{
"key": "accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "INTG-EVENT-debdf8a2-6986-4398-adfc-e50b185d049a",
"name": "Create event",
"notifier": {
"baseURI": "www.domain.com"
},
"payload": "{channel=#channelName, attachments=[{fallback=Incident create notification to slack, color=danger, pretext=New incident \u003c$esc.java($utils.ticketAccessURL($incident.id,$incident.client.id,$incident.msp.id,$incident.serviceProviderId))| # $esc.java($incident.uniqueId)\u003e created , author_name=By $esc.java($incident.createdBy.getFullName()), title=$incident.subject, title_link=$utils.ticketAccessURL($incident.id,$incident.client.id,$incident.msp.id,$incident.serviceProviderId), text=$incident.impact, fields=[{title=Priority, value=$incident.priority.name, short=false}], mrkdwn_in=[pretext], footer=OpsRamp, footer_icon=https://www.opsramp.com/wp-content/themes/twentythirteen/images/OpsRamp-Logo-300x300.png}]}"
},
{
"entity": "INCIDENT",
"filterCriteria": {
"actions": [],
"id": 140,
"matchType": "ALL",
"name": "Create event with policy",
"rules": [
{
"id": 579,
"key": "Subject",
"operator": "Contains",
"resourceType": "INCIDENT",
"value": "test"
},
{
"id": 580,
"key": "Description",
"operator": "Contains",
"resourceType": "INCIDENT",
"value": "testing"
}
]
},
"headers": [
{
"key": "accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "INTG-EVENT-717000e9-bc95-4339-adf7-db7a43db2580",
"name": "Create event with policy",
"notifier": {
"baseURI": "www.domain.com"
},
"payload": "{channel=#channelName, attachments=[{fallback=Incident create notification to slack, color=danger, pretext=New incident \u003c$esc.java($utils.ticketAccessURL($incident.id,$incident.client.id,$incident.msp.id,$incident.serviceProviderId))| # $esc.java($incident.uniqueId)\u003e created , author_name=By $esc.java($incident.createdBy.getFullName()), title=$incident.subject, title_link=$utils.ticketAccessURL($incident.id,$incident.client.id,$incident.msp.id,$incident.serviceProviderId), text=$incident.impact, fields=[{title=Priority, value=$incident.priority.name, short=false}], mrkdwn_in=[pretext], footer=OpsRamp, footer_icon=https://www.opsramp.com/wp-content/themes/twentythirteen/images/OpsRamp-Logo-300x300.png}]}"
},
{
"depEvent": {
"depEndPointURI": "www.attach.com/test",
"headers": [
{
"key": "accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"payload": "{attach payload}"
},
"entity": "INCIDENT",
"filterCriteria": {
"actions": [],
"id": 141,
"matchType": "ANY",
"name": "Create event with policy and dep",
"rules": [
{
"id": 581,
"key": "Subject",
"operator": "Contains",
"resourceType": "INCIDENT",
"value": "test"
},
{
"id": 582,
"key": "Description",
"operator": "Contains",
"resourceType": "INCIDENT",
"value": "testing"
}
]
},
"headers": [
{
"key": "accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "INTG-EVENT-c6d30f9c-2728-4760-ad97-8f3b6f2b6391",
"name": "Create event with policy and dep updated",
"notifier": {
"baseURI": "www.domain.com"
},
"payload": "{channel=#channelName, attachments=[{fallback=Incident create notification to slack, color=danger, pretext=New incident \u003c$esc.java($utils.ticketAccessURL($incident.id,$incident.client.id,$incident.msp.id,$incident.serviceProviderId))| # $esc.java($incident.uniqueId)\u003e created , author_name=By $esc.java($incident.createdBy.getFullName()), title=$incident.subject, title_link=$utils.ticketAccessURL($incident.id,$incident.client.id,$incident.msp.id,$incident.serviceProviderId), text=$incident.impact, fields=[{title=Priority, value=$incident.priority.name, short=false}], mrkdwn_in=[pretext], footer=OpsRamp, footer_icon=https://www.opsramp.com/wp-content/themes/twentythirteen/images/OpsRamp-Logo-300x300.png}]}"
},
{
"depEvent": {
"depEndPointURI": "https://urportal.com/create/tkt/attachment",
"headers": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"payload": "{\n'attach':'$attach.id'\n}",
"responseHeaders": [
{
"key": "id",
"value": "$attch.id"
}
]
},
"entity": "INCIDENT",
"headers": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "INTG-EVENT-0e85ed91-35b7-4fe8-a702-45fab935961c",
"name": "Ticket create event",
"notifier": {
"baseURI": "https://urportal.com/create/tkt"
},
"payload": "{\n'subject':'$incident.subject',\n'description':'$incident.impact',\n'priority':'$incident.priority.name'\n}",
"responseHeaders": [
{
"key": "extTicketId",
"value": "$id"
},
{
"key": "Error Message",
"value": "$err"
}
]
}
],
"totalPages": 1,
"totalResults": 4
}