Define a custom integration

Within Moogsoft, navigate to Integrations > Ingestion Services > Create your own Integration.

Click Add New Integration.

Under Moogsoft Endpoint, enter a unique name for your new integration (required).

Under API Description, enter a description for the integration (optional).

Under Data Type, select either Events or Metrics.

Click Save.

Keep the web page for this integration open in your browser while you complete the following steps in your third-party service.

Open your third-party service and create a new webhook. Consult the documentation for your third-party service for instructions on how to create an outbound webhook within their product.

Enter a unique name for the webhook, such as "Moogsoft."

Set the HTTP method to POST.

Paste your Moogsoft endpoint URL and API key in the appropriate authentication fields.

The endpoint URL is provided for you in Moogsoft on the page for your custom integration, under the Configuration Information section.

Save the webhook.

If necessary, configure the third-party service to use the webhook when it generates alerts. Consult the documentation for your third-party service if you need help.

Use the features of your third-party service to test the integration by sending a payload to your Moogsoft instance.

Go to your Moogsoft instance.

Open the page for your custom integration by going to Integrations > Ingestion Services > Create your own Integration > your-integration-name.

In the Map Your Data section, you can view cached payloads of incoming events sent from your third-party service. Confirm that events are flowing in before moving on to the next step. This may take some time.

If your data is structured in a nested format with multiple events below the top level, you may need to enable batch processing (optional).

Batch processing lets you define a path to events in your payload when events are nested under one or more levels. If your events are at one level, then it is not necessary to use this option. To learn more about batch processing, read Use batch processing with custom integrations.

In the grid under Map Your Data, map payload fields to required Moogsoft target fields. Select the payload field or fields on the left you want to map to each of the required fields on the right. If you choose multiple payload fields, Moogsoft will apply the value for the first non-blank field to the target field.

Map optional Moogsoft fields. Click Add a Mapping to add additional rows if needed. Select a payload field or fields on the left, click the target field entry on the right, and choose a regular or tag field. For events, you can also specify a location field.

You do not need to map every payload field, and you do not need to map to every optional Moogsoft field. You can click the trashcan icons to delete any rows that you do not want to map.

Map tags. If there are payload fields you want to include which do not have a direct equivalent in the Moogsoft event or metric schemas, map them to custom tags. Click Add a Mapping and select the payload field you want to map to a tag on the left. Click the target field entry on the right, click Add Tag, and provide a name for the tag field.

Keep the default mapping type for each row, or optionally change it by clicking the arrow between the payload and target field entries. For a complete list of mapping types, save options, and instructions on how to use them, read Use mapping types in custom integrations.

Go to the Set Your Deduplication Key section to preview, edit, and test your deduplication key (optional). The deduplication key is used to group similar events into alerts. For more information, read Configure deduplication key.

Go to the top of the page and click Save.

You have finished configuring your custom integration. The integration will remain in the "Provisioned" status until it processes an event or metric. Once incoming data is successfully processed, the status of the integration will change to "Active."