Install custom integration

URL

POST https://{api-url}/api/v2/tenants/{tenantId}/integrations/install/CUSTOM

Sample URLs

https://{api-url}/api/v2/tenants/client_8/integrations/install/CUSTOM

Parameters

Field	Sub-Fields	Data Type	Values	Description
displayName		String		Name used to identify the integration.
category		String	Custom, Collaboration, Monitoring, SSO, Automation	Category describes the behavior of custom integration. Applicable only for Custom Integration installation. Example: If monitoring is selected as category, the integration will work as monitoring integration.
alertSource		String		Source of alert. Applicable only when installing category is Monitoring. Default Alert Source is taken as Custom.
direction		String	Inbound-Outbound, Inbound, Outbound	Direction of the installation. Applicable only when installing category is Collaboration. The default direction is taken as Inbound-Outbound.
description		String		(Optional) Description of the Custom Integration. Maximum limit is 500 characters.
inboundConfig (Optional)	Authentication
	1. authType	String	WEBHOOK, OAUTH2	Type of authentication.
	2. role	String		Role of the user: Mandatory only when installing category is selected as Custom. Default user role is used depending on other installing categories.
	uniqueId	String		Unique ID of the role. For information on unique ID of the role, see Search Roles API.
	Map attributes
	1. name	String	NA	OpsRamp attribute name.
	2. tenantAttrName	String	NA	Third-party attribute name.
	3. entityType	String	ALERT, PROBLEM, INCIDENT, CHANGE,SERVICEREQUEST, TASK	OpsRamp entity type.
	4. tenantEntityType	String	NA	Third-party entity type.
	5. attrValues attrValue tenantAttrValue	String	NA	Mapping attribute values: OpsRamp mapping attribute value Third-party mapping attribute value
outboundConfig (Optional)	Map attributes
	1. name	String	NA	OpsRamp attribute name.
	2. tenantAttrName	String	NA	Third-party attribute name.
	3. entityType	String	ALERT, PROBLEM, INCIDENT, CHANGE,SERVICEREQUEST, TASK	OpsRamp entity type.
	4. tenantEntityType	String	NA	Third-party entity type.
	5. attrValues attrValue tenantAttrValue	String	NA	Mapping attribute values: OpsRamp mapping attribute value Third-party mapping attribute value
	2. notifier
	1. type	String	REST_API, SOAP_API	Notification type.
	2. authType	String	NONE, OAUTH2	Authentication type.
	3. grantType	String	CLIENT_CREDENTIALS, PASSWORD, REFRESH_TOKEN	Grant type for notification.
	4. userName	String	NA	Username: Mandatory when authType is OAUTH2 and grantType is PASSWORD/REFRESH_TOKEN.
	5. password	String	NA	Password: Mandatory when authType is OAUTH2 and grantType is PASSWORD/REFRESH_TOKEN.
	6. apiKey	String	NA	API Key: Mandatory if authType is OAUTH2.
	7. apiSecret	String	NA	API Secret: Mandatory if authType is OAUTH2.
	8. accessTokenURL	String	NA	Access Token URL: Mandatory if authType is OAUTH2.

NA indicates that the value is not applicable.

Status code

200 OK

Install custom integration with category and alert alertSource

Sample request

{
	"displayName" : "API Testing",
	"category" : "Monitoring",
	"alertSource" : {
		"id" : "30"
	}
}

Sample response

{
    "id": "INTG-6aa0bbec-ef5b-4ff2-b373-5a4f7ab0a385",
    "displayName": "API Testing",
    "integration": {
        "id": "CUSTOM",
        "name": "Custom"
    },
    "category": "Monitoring",
    "alertSource": {
        "id": 30,
        "name": "Custom",
        "displayName": "Custom",
        "techUid": "CUSTOM"
    }
}

Install custom integration with category and direction

Sample request

{
	"displayName" : "InboundApp",
	"category" : "Collaboration",
        "direction" : "Inbound"
}

Sample response

{
    "id": "INTG-7213eaa0-8c59-42b2-a1db-90147cfd3ef3",
    "displayName": "InboundApp",
    "integration": {
	"id": "CUSTOM",
	"name": "Custom"
    },
    "category": "Collaboration",
    "direction" : "Inbound"
}

Install custom integration with only authentication details

Sample request

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

Sample response

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