OpsRamp provides you the capability to build your integration using the Custom Integration framework.

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

Alerts or tickets are integrated from any third-party application that supports REST APIs.

Using Custom integration, multiple tenants can inherit properties of a parent integration automatically without using respective configuration. For more details, view Custom integration for multiple tenants with inherited details.

Custom integration types

Custom integration provides multiple options to set up the integration.

Integration TypeDescriptionAssociated RoleConfiguration TypeInbound Authentication
CustomDefault integration category. Custom is used when your integration is not available in the list of OpsRamp available integrations.Multiple rolesBidirectionalOAUTH2
CollaborationCollaboration displays the Direction field where you need to specify the direction of collaboration integration. Available options are Inbound-Outbound, Inbound, and Outbound. If a direction is not specified, Inbound-Outbound is selected as the default direction.Default roleBidirectionalOAUTH2, Webhook
MonitoringSelecting Monitoring displays the Alert Source field where you need to specify the alert source from the Alert Source drop-down list. If an alert source is not selected, Custom is selected as the default alert source.Default roleInboundOAUTH2, Webhook
Process AutomationSelect to create an integration for custom automationNAOutboundNA
SSOSelect to create a custom integration for the unique client. You can install and integrate only one instance of SSO installation. If an SSO integration is already installed using the SSO tab from Available Integrations, the SSO category is not displayed in Custom Integrations.NANANA

Custom integration configuration steps depend on the use cases described in the following subsections.

Bidirectional data transfer option (inbound and outbound)

Applicable integration types: custom, collaboration

Bidirectional integration includes both Inbound (third-party application to OpsRamp) and Outbound (OpsRamp to third-party application) communication.

This collaboration integration supports the webhook-based inbound calls with different types of service management requests. For example, you can select one or multiple Entity Types from Incident, Service Request, Problem, and Change.

Step 1: Install the custom integration

  1. From All Clients, select a client.

  2. Go to Setup > Account.

  3. Select the Integrations and Apps tab.

  4. The Installed Integrations page, where all the installed applications are displayed. Note: If there are no installed applications, it will navigate to the Available Integrations and Apps page.

  5. Click + ADD on the Installed Integrations page. The Available Integrations and Apps page displays all the available applications along with the newly created application with the version.
    Note: You can even search for the application using the search option available. Also you can use the All Categories option to search.

  6. Click ADD in the Custom Integration application.

  7. Click Install.

  8. Enter the following information:

    • Name
    • Description
    • Category: Select Custom or Collaboration from the drop-down option.
    • Upload Logo

  9. Click Install.

Step 2: Configure the custom integration

The custom integration category allows for bidirectional communication. Bidirectional integration includes both inbound (third-party application to OpsRamp)) and outbound (OpsRamp to Third-party application) communication.

To configure inbound-outbound communication, enter:

Configure inbound communication

  • Authentication Type: OpsRamp supports APIs with OAUTH2 for Custom.
    • Role: Select the role of the user installing the integration.
      You can execute only those APIs that are associated with the selected role.
    • Click Save and make a note of the Tenant Id, Key, and Secret or Token and Webhook URL depending upon the authentication type selected.
    • Map Attributes: Map the tenant entity attributes with OpsRamp entity if any.
      • Field mapping: Maps the fields from your application entity attributes to OpsRamp entity attributes.
        Example: If you are trying to integrate events as OpsRamp alerts, alert subject, alert description, alert time, alert resource, and hostname are field mapping attributes.
        • Field value mappings: If an attribute has multiple values to map, that attribute falls under field value mappings.
          Example: If you are trying to integrate events as OpsRamp alerts, alert state (with values critical, warning, Info) and alert metric are field value mapping attributes.
          Notes:
          • For Webhook authentication type, map attributes only if your application supports Webhooks with JSON format.
            • Mapping attributes is NOT required if your application is capable of calling OpsRamp APIs with OAuth2 authentication.
    • ITSM Properties: Define properties required to call Custom APIs using events.

Configure outbound communication

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

  • Integration Basic Authentication Configuration: Configure basic notification details to trigger the integration events defined. Provide third-party application details, such as REST API URL and authentication details. This step is not required. You can also configure notification details as part of defining integration events.
    For JWT, select REST API as Notification Type and JWT as Authentication Type. Enter the JWT authentication for Username and Password based on the third-party applications. You can also enter the attributes in any of the following: - Headers - Payload - Query parameter in URI
    • Map Attributes: Maps the tenant entity attributes with the OpsRamp entity if any. This mapping is not required, you can also map attributes as part of defining integration events. This is similar to Inbound mapping attributes. In outbound, OpsRamp converts the mapping attributes data before sending it to the third-party application.
      Only one mapping attribute is required.
      Field value mappings: If an attribute has multiple values to map, that attribute falls under field value mappings.
      Example: If you are trying to integrate incidents from OpsRamp to your application, the incident status and priority are the attributes available to map values.
    • Integration Events: Events are used for sending certain notifications when an action is performed on OpsRamp entities. Integration event configuration carries the information of OpsRamp entities to integrated, JSON payload, headers, response parsing details. Configure the JSON payload with the placeholder tokens. Actual data is replaced dynamically at run time. Placeholders are provided on the right pane.
      • Validate: Validate the integration by providing the hard-coded JSON data payload. This validation event is not audited. The response from the third-party application is displayed after validation.
        • Failure notifications: Configure your email address to get notified about failures.
  • Monitoring of Integrations
    Select templates from Monitoring of Integrations if you want to monitor integration failures. See monitoring integration failures for more information.
  • Audit Logs
    View logs from the Audit Logs tab.
    Logs are visible only after successful API calls.

See Freshservice Integration for more information.

Receive data option (inbound)

Applicable integration types: collaboration, monitoring

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.

This collaboration integration supports the webhook-based inbound calls with different types of service management requests. For example, you can select one or multiple Entity Types from Incident, Service Request, Problem, and Change.

To configure inbound communication, follow the steps mentioned for inbound under the Bidirectional scenario.

See Webhook integration using a custom framework for more information.

Transmit data option (outbound)

Applicable integration type: collaboration

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

To configure outbound communication, follow the steps mentioned for outbound under the Bidirectional scenario.

Transmit data option (outbound) for automation

Outbound configurations to send data from OpsRamp and used as workflow entities for automation. See Automation Integration for details.

Third-party SSO authentication

SSO integration allows specifying custom third-party SSO integrations.

To configure SSO integration, enter:

  • 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).

If you select JIT, map attributes for the user role.

See Okta Configuration for details.