Documentation is now available for the Fall 2020 Update release!

Update custom integration

This endpoint is used to update a custom integration.

Leave Feedback

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-7c2cdbff-1da9-4384-9189-a1a87e61c2c4

Parameters

All fields are mandatory:

FieldSub-FieldsData TypeValuesDescription
inboundConfigAuthentication
1. authTypeStringWEBHOOK, OAUTH2Type of authentication.
2. roleStringRole of the user. Mandatory only when installing category is selected as Custom. Default user role is used depending on other installing categories.
  • uniqueId
StringUnique ID of the role. For information on unique ID of the role, see Search Roles API.
Map attributes
1. nameStringNAOpsRamp attribute name.
2. tenantAttrNameStringNAThird-party attribute name.
3. entityTypeStringALERT, PROBLEM, INCIDENT, CHANGE,SERVICEREQUEST, TASKOpsRamp entity type.
4. tenantEntityTypeStringNAThird-party entity type.
5. attrValues
  • attrValue
  • tenantAttrValue
StringNAMapping attribute values:
  • OpsRamp mapping attribute value
  • Third-party mapping attribute value
outboundConfigMap attributes
1. nameStringNAOpsRamp attribute name.
2. tenantAttrNameStringNAThird-party attribute name.
3. entityTypeStringALERT, PROBLEM, INCIDENT, CHANGE,SERVICEREQUEST, TASKOpsRamp entity type.
4. tenantEntityTypeStringNAThird-party entity type.
5. attrValues
  • attrValue
  • tenantAttrValue
StringNAMapping attribute values:
  • OpsRamp mapping attribute value
  • Third-party mapping attribute value
notifier
1. type StringREST_API, SOAP_APINotification type.
2. authType StringNONE, OAUTH2Authentication type.
3. grantType StringCLIENT_CREDENTIALS, PASSWORD, REFRESH_TOKENGrant type for notification.
4. userName StringNA(OAUTH2) Username. Mandatory when authType is OAUTH2 and grantType is PASSWORD/REFRESH_TOKEN.
5. password StringNA(OAUTH2) Password . Mandatory when authType is OAUTH2 and grantType is PASSWORD/REFRESH_TOKEN.
6. apiKey StringNA(OAUTH2) API Key. Mandatory if authType is OAUTH2.
7. apiSecret StringNA(OAUTH2) API Secret. Mandatory if authType is OAUTH2.
8. accessTokenURL StringNA(OAUTH2) Access Token URL. Mandatory if authType is OAUTH2.
9. tokenPayloadString(JWT only) Payload for the token.
10. tokenURLString(JWT only) Access token URI.
11. tokenHeadersString(JWT only) Headers to request the token.
12. tokensPathString(JWT only) Token path in the response of the authentication REST call.
13. resourceAuthHeadersString(JWT only) Authorization header for resource calls.

NA indicates that the value is not applicable.

Status code

200 OK

Update custom integration with only authentication

Sample request

{
    "displayName": "Custom Integration",
	"inboundConfig": {
		"authentication": {
			"authType": "OAUTH2",
                        "role":{
                                "uniqueId" : "ROLE-4718b729-50cc-6634-42c4-ecd09558389d"
                        }
		}
	}
}

Sample response

{
    "id": "INTG-58431d1c-1bdc-4a68-a49f-34435ead1d14",
    "displayName": "Custom Integration",
    "integration": {
        "id": "CUSTOM",
        "name": "Custom"
    },
    "inboundConfig": {
        "authentication": {
            "authType": "OAUTH2",
            "token": "7VttjkVtm7qk6AwaRpED4Uh4jdAFpaVb",
            "role": {
                "uniqueId": "ROLE-4718b729-50cc-6634-42c4-ecd09558389d",
                "name": "Customer"
            }
        }
    }
}

Update custom integration with only authentication

Sample request

{
    "displayName": "Custom Integration",
	"inboundConfig": {
		"authentication": {
			"authType": "WEBHOOK"
		}
	}
}

Sample response

{
	"id": "INTG-9c584c86-4ba9-4006-9ee2-c41a07b7c761",
  	"integration": {
    	"id": "CASERVICEDESK",
    	"name": "Service Desk"
  	},
  	"inboundConfig": {
    	"authentication": {
      		"authType": "WEBHOOK",
      		"token": "YTxSGJdfkkfE3m7WaE8jYkwmsYjNU3VU"
    	}
	}
}

Update custom integration with inbound configuration

Sample request

{
"inboundConfig": {
		"authentication": {
			"authType": "WEBHOOK"
		},
		"mapAttributes": [{
			"name": "Status",
			"thirdPartyAttrName": "Status",
			"entityType": "SERVICEREQUEST",
			"thirdPartyEntityType": "SRQ",
			"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": "Max"
			}, {
				"attrValue": "Low",
				"thirdPartyAttrValue": "min"
			}]
		}, {
			"name": "Priority",
			"thirdPartyAttrName": "severity",
			"entityType": "SERVICEREQUEST",
			"thirdPartyEntityType": "SRQ",
			"attrValues": [{
				"attrValue": "High",
				"thirdPartyAttrValue": "Max"
			}, {
				"attrValue": "Low",
				"thirdPartyAttrValue": "min"
			}]
		}]
	}
}

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": "SRQ",
			"attrValues": [{
				"attrValue": "Open",
				"thirdPartyAttrValue": "In Progress"
			}, {
				"attrValue": "Closed",
				"thirdPartyAttrValue": "Completed"
			}]
		}, {
			"name": "Status",
			"attrName": "incident.status.name",
			"thirdPartyAttrName": "stats",
			"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": "Max"
			}, {
				"attrValue": "Low",
				"thirdPartyAttrValue": "min"
			}]
		}, {
			"name": "Priority",
			"attrName": "serviceRequest.priority.name",
			"thirdPartyAttrName": "severity",
			"entityType": "SERVICEREQUEST",
			"thirdPartyEntityType": "SRQ",
			"attrValues": [{
				"attrValue": "High",
				"thirdPartyAttrValue": "Max"
			}, {
				"attrValue": "Low",
				"thirdPartyAttrValue": "min"
			}]
		}]
	}
}

Update custom integration with outbound configuration

Sample request

{
	"outboundConfig": {
		"mapAttributes": [{
			"name": "Status",
			"thirdPartyAttrName": "stats",
			"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": "pk",
			"accessTokenURI": "www.token.com/cred",
			"apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
			"apiSecret": "asdfgnasinfpaiwerpfawpeojporwjaeprfwpejprwje"
		}
	}
}

Sample response

{
	"id": "INTG-9c584c86-4ba9-4006-9ee2-c41a07b7c761",
	"integration": {
		"id": "CASERVICEDESK",
		"name": "Service Desk"
	},
	"outboundConfig": {
		"baseNotifier": {
			"baseURI": "www.google.com",
			"authType": "OAUTH2",
			"grantType": "PASSWORD",
			"userName": "testUser",
			"apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
			"accessTokenURL": "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"
			}]
		}]
	}
}

Update custom integration with inbound and outbound configuration

Sample request

{
	"inboundConfig": {
		"authentication": {
			"authType": "WEBHOOK"
		},
		"mapAttributes": [{
			"name": "Status",
			"thirdPartyAttrName": "Status",
			"entityType": "SERVICEREQUEST",
			"thirdPartyEntityType": "SRQ",
			"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": "Max"
			}, {
				"attrValue": "Low",
				"thirdPartyAttrValue": "min"
			}]
		}, {
			"name": "Priority",
			"thirdPartyAttrName": "severity",
			"entityType": "SERVICEREQUEST",
			"thirdPartyEntityType": "SRQ",
			"attrValues": [{
				"attrValue": "High",
				"thirdPartyAttrValue": "Max"
			}, {
				"attrValue": "Low",
				"thirdPartyAttrValue": "min"
			}]
		}]
	},
	"outboundConfig": {
		"mapAttributes": [{
			"name": "Status",
			"thirdPartyAttrName": "stats",
			"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": "pk",
			"accessTokenURL": "www.token.com/cred",
			"apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
			"apiSecret": "asdfgnasinfpaiwerpfawpeojporwjaeprfwpejprwje"
		}
	}
}

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": "SRQ",
        "attrValues": [
          {
            "attrValue": "Open",
            "thirdPartyAttrValue": "In Progress"
          },
          {
            "attrValue": "Closed",
            "thirdPartyAttrValue": "Completed"
          }
        ]
      },
      {
        "name": "Status",
        "attrName": "incident.status.name",
        "thirdPartyAttrName": "stats",
        "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": "Max"
          },
          {
            "attrValue": "Low",
            "thirdPartyAttrValue": "min"
          }
        ]
      },
      {
        "name": "Priority",
        "attrName": "serviceRequest.priority.name",
        "thirdPartyAttrName": "severity",
        "entityType": "SERVICEREQUEST",
        "thirdPartyEntityType": "SRQ",
        "attrValues": [
          {
            "attrValue": "High",
            "thirdPartyAttrValue": "Max"
          },
          {
            "attrValue": "Low",
            "thirdPartyAttrValue": "min"
          }
        ]
      }
    ]
  },
  "outboundConfig": {
    "baseNotifier": {
      "baseURI": "www.google.com",
      "authType": "OAUTH2",
      "grantType": "PASSWORD",
      "userName": "testUser",
      "apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
      "accessTokenURL": "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"
          }
        ]
      }
    ]
  }
}

Update custom integration with outbound JWT authentication

Sample request

{
    "outboundConfig": {
        "mapAttributes": [{
            "name": "Status",
            "thirdPartyAttrName": "stats",
            "entityType": "INCIDENT",
            "thirdPartyEntityType": "Ticket",
            "attrValues": [{
                "attrValue": "Open",
                "thirdPartyAttrValue": "good"
            }]
        }],
        "baseNotifier": {
    "type": "REST_API",
    "baseURI": "https://us1-smax.saas.microfocus.com",
    "authType": "JWT",
    "userName":"test",
    "password":"Test",
    "tokenPayload" : {"rest":""},
    "tokenURL" : "https://us1-smax.saas.microfocus.com/auth/authentication-endpoint/authenticate/login",
    "tokenHeaders" : [
        {
            "key" : "Authorization",
            "value" : "Basic Base64EncodedCredentials"
        },
        {
            "key" : "accept",
            "value" : "application/json"
        },
        {
            "key" : "Content-Type",
            "value" : "application/json"
        }   
    ],
    "tokensPath" : [
        {
            "key" : "jwtToken",
            "value" : "rest_access.access_key"
        }
    ],
    "resourceAuthHeaders" : [
        {
            "key" : "accept",
            "value" : "$jwtToken"
        }
    ]
    
}
    }
}

Sample response

{
    "id": "INTG-3f62e5c1-643b-41e3-a836-11c616e6f5df",
    "displayName": "AsPI Tnmesting",
    "integration": {
        "id": "CUSTOM",
        "name": "Custom"
    },
    "outboundConfig": {
        "baseNotifier": {
            "baseURI": "https://us1-smax.saas.microfocus.com",
            "authType": "JWT",
            "userName": "test"
        },
        "mapAttributes": [
            {
                "name": "Status",
                "attrName": "incident.status.name",
                "thirdPartyAttrName": "stats",
                "entityType": "INCIDENT",
                "thirdPartyEntityType": "Ticket",
                "mode": "OUTBOUND",
                "attrValues": [
                    {
                        "attrValue": "Open",
                        "thirdPartyAttrValue": "good"
                    }
                ]
            }
        ]
    },
    "category": "Custom"
}