URL
POST https://{api-url}/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}
Sample URLs
https://{api-url}/api/v2/tenants/client_8/integrations/installed/INTG-9c584c86-4ba9-4006-9ee2-c41a07b7c761
Parameters
Field | Subfields | Data Type | Description |
---|---|---|---|
inboundConfig | 1. authentication authType | String | Authentication type: WEBHOOK, OAUTH2 Example: OAUTH2 |
2. mapAttributes: Map third-party attributes with OpsRamp attributes. Below are the map attributes. | |||
name | String | OpsRamp attribute name. Example: Priority | |
thirdPartyAttrName | String | Third-party attribute name. Example: Severity | |
entityType | String | OpsRamp Entity type.ALERT, PROBLEM, INCIDENT, CHANGE, SERVICEREQUEST, TASK Example: INCIDENT | |
thirdPartyEntityType | String | Third-party entity type. Example: Ticket | |
attrValues
| String |
| |
outboundConfig | 1. mapAttributes: Map third-party attributes with OpsRamp attributes. Below are the map attributes. | ||
name | String | OpsRamp attribute name. Example: Priority | |
thirdPartyAttrName | String | Third-party attribute name. Example: Severity | |
entityType | String | OpsRamp Entity type.PROBLEM, INCIDENT, CHANGE, SERVICEREQUEST, TASK Example: ALERT | |
thirdPartyEntityType | String | Third-party entity type. Example: Ticket | |
attrValues
| String |
| |
2. notifier: Notify events generated in OpsRamp to third-party entities. Notifications are sent with the attributes mentioned below. | |||
type | String | Notifer type. SOAP_API, REST_API Example: REST_API | |
authType | String | Authentication type. NONE, OAUTH2 Example: OAUTH2 | |
grantType | String | Grant type. CLIENT_CREDENTIALS, PASSWORD_CREDENTIALS, REFRESH_TOKEN. Valid only if authentication type is OAUTH2. Example: CLIENT_CREDENTIALS | |
userName | String | Provide user credentials of the person sending the notifier. Valid only when authentication type is OAUTH2 and grant type is PASSWORD_CREDENTIALS/REFRESH_TOKEN. | |
password | String | Provide password of the user account. Valid only when authentication type is OAUTH2 and grant type is PASSWORD_CREDENTIALS/REFRESH_TOKEN. | |
apiKey | String | API key. Valid only if authentication type is OAUTH2. | |
apiSecret | String | API secret. Valid only if authentication type is OAUTH2. | |
accessTokenURI | String | URI used to get the access token. | |
alertSource | String | (Optional) Source of alert. Applicable to Email Alert and Custom Integration Updates for Monitoring Integration category. View Alert Technologies API to know about the list of allowed Alert Sources. |
Status code
200 OK
Sample request
{
"inboundConfig": {
"authentication": {
"authType": "WEBHOOK"
},
"mapAttributes": [{
"name": "Status",
"thirdPartyAttrName": "Status",
"entityType": "SERVICEREQUEST",
"thirdPartyEntityType": "REQUEST",
"attrValues": [{
"attrValue": "Open",
"thirdPartyAttrValue": "In Progress"
},
{
"attrValue": "Closed",
"thirdPartyAttrValue": "Completed"
}
]
},
{
"name": "Status",
"thirdPartyAttrName": "Status",
"entityType": "INCIDENT",
"thirdPartyEntityType": "TICKET",
"attrValues": [{
"attrValue": "Open",
"thirdPartyAttrValue": "In Progress"
},
{
"attrValue": "Closed",
"thirdPartyAttrValue": "Completed"
}
]
},
{
"name": "Priority",
"thirdPartyAttrName": "severity",
"entityType": "INCIDENT",
"thirdPartyEntityType": "TICKET",
"attrValues": [{
"attrValue": "High",
"thirdPartyAttrValue": "Maximum"
},
{
"attrValue": "Low",
"thirdPartyAttrValue": "Minimum"
}
]
},
{
"name": "Priority",
"thirdPartyAttrName": "Severity",
"entityType": "SERVICEREQUEST",
"thirdPartyEntityType": "REQUEST",
"attrValues": [{
"attrValue": "High",
"thirdPartyAttrValue": "Maximum"
},
{
"attrValue": "Low",
"thirdPartyAttrValue": "Minimum"
}
]
}
]
},
"outboundConfig": {
"mapAttributes": [{
"name": "Status",
"thirdPartyAttrName": "Status",
"entityType": "INCIDENT",
"thirdPartyEntityType": "Ticket",
"attrValues": [{
"attrValue": "Ok",
"thirdPartyAttrValue": "Good"
},
{
"attrValue": "Critical",
"thirdPartyAttrValue": "Bad"
}
]
}],
"baseNotifier": {
"type": "REST_API",
"baseURI": "www.google.com",
"authType": "OAUTH2",
"grantType": "PASSWORD",
"userName": "testUser",
"password": "*************",
"accessTokenURI": "www.token.com/cred",
"apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
"apiSecret": "***************************"
}
}
}
Sample response
{
"id": "INTG-9c584c86-4ba9-4006-9ee2-c41a07b7c761",
"integration": {
"id": "CASERVICEDESK",
"name": "Service Desk"
},
"inboundConfig": {
"authentication": {
"authType": "WEBHOOK",
"token": "YTxSGJdfkkfE3m7WaE8jYkwmsYjNU3VU"
},
"mapAttributes": [{
"name": "Status",
"attrName": "ServiceRequest.status.name",
"thirdPartyAttrName": "Status",
"entityType": "SERVICEREQUEST",
"thirdPartyEntityType": "REQUEST",
"attrValues": [{
"attrValue": "Open",
"thirdPartyAttrValue": "In Progress"
},
{
"attrValue": "Closed",
"thirdPartyAttrValue": "Completed"
}
]
},
{
"name": "Status",
"attrName": "incident.status.name",
"thirdPartyAttrName": "Status",
"entityType": "INCIDENT",
"thirdPartyEntityType": "Ticket",
"attrValues": [{
"attrValue": "Ok",
"thirdPartyAttrValue": "Good"
},
{
"attrValue": "Critical",
"thirdPartyAttrValue": "Bad"
},
{
"attrValue": "Open",
"thirdPartyAttrValue": "In Progress"
},
{
"attrValue": "Closed",
"thirdPartyAttrValue": "Completed"
}
]
},
{
"name": "Priority",
"attrName": "incident.priority.name",
"thirdPartyAttrName": "Severity",
"entityType": "INCIDENT",
"thirdPartyEntityType": "TICKET",
"attrValues": [{
"attrValue": "High",
"thirdPartyAttrValue": "Maximum"
},
{
"attrValue": "Low",
"thirdPartyAttrValue": "Minimum"
}
]
},
{
"name": "Priority",
"attrName": "serviceRequest.priority.name",
"thirdPartyAttrName": "Severity",
"entityType": "SERVICEREQUEST",
"thirdPartyEntityType": "REQUEST",
"attrValues": [{
"attrValue": "High",
"thirdPartyAttrValue": "Maximum"
},
{
"attrValue": "Low",
"thirdPartyAttrValue": "Minimum"
}
]
}
]
},
"outboundConfig": {
"baseNotifier": {
"baseURI": "www.google.com",
"authType": "OAUTH2",
"grantType": "PASSWORD",
"userName": "testUser",
"apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
"accessTokenURI": "www.token.com/cred"
},
"mapAttributes": [{
"name": "Status",
"attrName": "incident.status.name",
"thirdPartyAttrName": "stats",
"entityType": "INCIDENT",
"thirdPartyEntityType": "Ticket",
"attrValues": [{
"attrValue": "Ok",
"thirdPartyAttrValue": "Good"
},
{
"attrValue": "Critical",
"thirdPartyAttrValue": "Bad"
},
{
"attrValue": "Ok",
"thirdPartyAttrValue": "Good"
},
{
"attrValue": "Critical",
"thirdPartyAttrValue": "Bad"
}
]
}]
}
}