Custom Integration

Describes how to set up custom integrations.

Leave Feedback

Introduction

Custom integration is configured between OpsRamp and your application if any third-party, or other in-house applications are not already in the available integrations list.

Installing the custom integration

To install:

  1. From All Clients, select a client.
  2. Go to Setup > Integrations > Integrations.
  3. From Available Integrations, select Other > Custom Integration and click Install.
  4. Provide the following:
    • Name
    • Description
    • Category: Select the type of integration from the drop-down menu. Available options: custom, automation, collaboration, monitoring, and SSO.
    • Upload Logo
    • Use Partner configuration and events: This is an alternative to specifying the category.
  5. Click Install.

Configuring custom integrations

The custom integration category allows bi-directional communication. Bi-directional integration includes both inbound (3rd-party application to OpsRamp)) and outbound (OpsRamp to 3rd-party application) communication.

To configure inbound-outbound communication, provide the following:

  • For Inbound:
    • Authentication - OpsRamp currently supporting APIs with OAUTH2 and HTTP Basic. Please capture the respective information to call the API from the custom integration.
    • Map Attributes - Map the tenant entity attributes with OpsRamp entity if any.
    • ITSM Properties - Define properties required to call Custom APIs using events.
  • For Outbound:
    • Integration Basic Configuration - Configure basic notification details to trigger the integration events defined. Provide third-party application REST API URL, authentication details, etc. This step is not mandatory, you can also configure notification details as part of defining integration events.
    • Map Attributes - Maps the tenant entity attributes with the OpsRamp entity if any. This mapping is not mandatory, you can also map attributes as part of defining integration events.
    • Integration Events - Events are used for sending certain notifications whenever an action is performed on OpsRamp entities.
  • For Audit Logs (optional):
    • Outbound or inbound with the associated ID.
    • Date range
    • Status type

Configuring automation integrations

Custom automation integrations allow you to provide event notifications. Automation is an outbound communication.

To configure automation integration, provide the following:

  • Integration Basic Configuration - Configure basic notification details to trigger integration events as defined. This step is not mandatory, you can also configure notification details as part of defining integration events.
  • Integration Events - Events are used for sending certain notifications whenever an action is performed on OpsRamp entities.
  • For Audit Logs (optional):
    • Outbound or inbound with the associated ID.
    • Date range
    • Status type

Configuring collaboration integrations

Custom collaboration integrations provide:

  • Bi-directional communications
  • Inbound communications
  • Outbound communications

Bi-directional communication

Bi-directional collaboration integration includes both inbound (3rd-party application to OpsRamp)) and outbound (OpsRamp to 3rd-party application) communication.

To configure inbound-outbound communication, provide the following:

  • For Inbound:
    • Authentication - OpsRamp currently supporting APIs with OAUTH2 and HTTP Basic. Please capture the respective information to call the API from the custom integration.
    • Map Attributes - Map the tenant entity attributes with OpsRamp entity if any.
    • ITSM Properties - Define properties required to call Custom APIs using events.
  • For Outbound:
    • Integration Basic Configuration - Configure basic notification details to trigger the integration events defined. Provide third-party application REST API URL, authentication details, etc. This step is not mandatory, you can also configure notification details as part of defining integration events.
    • Map Attributes - Maps the tenant entity attributes with the OpsRamp entity if any. This mapping is not mandatory, you can also map attributes as part of defining integration events.
    • Integration Events - Events are used for sending certain notifications whenever an action is performed on OpsRamp entities.
  • For Audit Logs (optional):
    • Outbound or inbound with the associated ID.
    • Date range
    • Status type

Inbound communication

In this scenario, data is captured inbound to OpsRamp. Inbound configurations capture all the details required to call OpsRamp APIs in a third-party application. Capturing or consuming data into OpsRamp includes only inbound communication.

To configure inbound communication, provide the following:

  • Authentication - OpsRamp currently supporting APIs with OAUTH2 and HTTP Basic. Please capture the respective information to call the API from the custom integration.
    • Map Attributes - Map the tenant entity attributes with OpsRamp entity if any.
    • ITSM Properties - Define properties required to call Custom APIs using events.n.

Outbound communication

Outbound configurations capture all details required to call 3rd-party application APIs from OpsRamp.

To configure outbound communication, provide the following:

  • Integration Basic Configuration - Configure basic notification details to trigger the integration events defined. Provide third-party application REST API URL, authentication details, etc. This step is not mandatory, you can also configure notification details as part of defining integration events.
  • Map Attributes - Maps the tenant entity attributes with the OpsRamp entity if any. This mapping is not mandatory, you can also map attributes as part of defining integration events.
  • Integration Events - Events are used for sending certain notifications whenever an action is performed on OpsRamp entities.

Configuring monitoring integrations

Custom monitoring integration allows selection of an alert source. Monitoring is an inbound communication.

To configure monitoring integration:

  • Provide the general integration
  • Select an alert source and provide:
  • Authentication - OpsRamp currently supporting APIs with OAUTH2 and HTTP Basic. Please capture the respective information to call the API from the custom integration.
  • Map Attributes - Map the tenant entity attributes with OpsRamp entity if any.
  • For Audit Logs (optional):
    • Outbound or inbound with the associated ID.
    • Date range
    • Status type

Configuring SSO integrations

SSO integration allows specify custom third party SSO integrations.

To configure SSO integration, provide the following:

  • Issuer URL: Identity provider Issuer URL
  • Redirection URL: SAML EndPoints for HTTP
  • Logout URL: URL for logging out
  • Certificate: x.509 Certificate

Once installed, verify the configuration information (properties and user provision) and optionally, provide audit log information:

  • Outbound or inbound communication with the associated ID.
  • Date range
  • Status type