Skip to main content

Create your own integration (CYOI)

A custom integration is a user-defined endpoint that ingests JSON objects and converts them to APEX AIOps Incident Management events or metrics. Custom integrations enable you to ingest data from third-party systems with different schemas. When you set up a custom integration, you specify how to map the third-party data to Incident Management-compatible event or event objects.

Custom integrations have the following features:

  • A UI that guides you through the process of creating a custom endpoint and mapping third-party data fields to Incident Management fields.

    For events, you can also map third-party severities to Incident Management severities.

  • Support for basic and bearer token authentication using API keys.

  • No limit on the number of unique API endpoints you can create per workspace.

  • Support for testing and validating the mapping.

    You must validate an integration before you enable it. To be considered valid, an API must include mappings for all required event or metric fields. If the incoming payload does not include the data for a required field, you can specify a plain-text placeholder such as "unknown" instead.

  • If your third-party schema does not include a field that corresponds directly to an Incident Management field, you can create event workflows to enrich and process your data after ingestion. The Example scenario for CYOI and the Event workflow configuration example together illustrate a simple end-to-end configuration process.

For step-by-step instructions, see Define a custom integration.