Custom Integration: Connect Alarms to Any Tool

Custom Integration

Third Party Integration

Custom Integration

Connect Cloudmon alarms to any ticketing system, event-management tool or chat webhook from the UI, with no engineering work for each new target.

Overview

The Custom Integration lets you connect Cloudmon alarms to any third-party tool that has a REST API. You configure a Create action and, for ticketing and event tools, a Manage action (Update and Close). Cloudmon then creates the ticket or event when an alarm fires, updates it when the severity changes and closes it when the alarm clears. The integration is attached to alarms through your existing notification profile flow.

Any REST API
Set the URL, method, headers and body for your own tool.
Full ticket lifecycle
Create on alarm, update on severity change, close on clear.
Replaceable tags
Type $ to insert alarm and device details into any body.

Integration Types

Choose the type that matches your target tool.

TypeBehavior
Incident ManagementFull lifecycle: Create, then Update when the severity changes, then Close when the alarm clears. The created ticket is linked to the alarm.
Event ManagementWorks exactly like Incident Management. The type is only a display label for your own reference.
ChatRuns the Create action (shown as Send Message) on every alarm notification. There is no ticket lifecycle, no Manage action and no alarm linking. It works like the Custom Hook webhook.

How It Works

Incident Management and Event Management
1. Alarm raised
Cloudmon detects an issue
➜2. Create action
Ticket or event is created in your tool
➜3. ID saved
Ticket ID is read from the response
and linked to the alarm
4. Severity changes
Manage action sends the
    Update body
➜5. Alarm clears
Manage action sends the Close body
➜6. Ticket closed
Status stays in sync with the alarm
Chat
Alarm notification
Cloudmon raises an alarm
➜Send Message action
Runs every time
➜Message delivered
Appears in your chat tool

Before You Begin: Collect Details from Your Tool

Collect the following from your target tool's API documentation before you configure the integration in Cloudmon.

FieldDescription
Create endpointThe URL and HTTP method used to create a ticket, event or message.
AuthenticationThe auth type and credentials the API expects, such as a username and password or an API key in a header.
Request body formatThe fields the API requires, and whether it expects JSON, form-data or form-urlencoded.
Manage endpointIncident and Event only. The URL and method used to update and close a ticket. One endpoint is shared by Update and Close, and the body decides which happens.
Severity valuesThe values your tool expects for priority, impact or urgency, so you can map each Cloudmon severity to them.

Step 1: Configure in Cloudmon

1
Navigate to Settings → Integrations.
2
Locate the Custom Integration card and click + Add.
3
Complete Integration Details and the Create Action, as described in the tables below.
4
Click Test Connection and confirm it succeeds.
5
For Incident and Event types, complete the Manage Action, which unlocks after a successful test.
6
Configure Ticket Settings and Severity Value Mappings.
7
Click Save.
Integration Details
FieldDescription
NameA display name to identify this integration in Cloudmon.
Integration TypeSelect Incident Management, Event Management or Chat.

Create Action (called Send Message for Chat)

FieldDescription
URL and MethodThe endpoint and HTTP method used to create the ticket, event or message.
Verify SSL CertificateChecks the SSL certificate of the URL. This is one shared setting, shown under every URL field.
Data TypeSelect raw, form-data or form-urlencoded.
Content TypeThe content type of the request body, for example application/json.
Request HeadersAny headers the API requires.
BodyThe request body. Type $ to pick a replaceable tag from the list.
AuthenticationUser Agent, Timeout, Auth Type, Username and Password. These sit next to Test Connection because testing needs the full connection details.
Test Connection

Click Test Connection to send your real Create body to the target. Cloudmon fills in the tags using a minimal sample alarm ("Test alert from Cloudmon") and shows the raw response. Because your actual body is used, tools that reject unknown fields, such as Freshdesk, are tested accurately.

Note: A successful test creates a real ticket, event or message in your tool. You may want to delete it afterwards.
Manage Action (Incident and Event Management only)

This section is locked until Test Connection succeeds on a new integration.

FieldDescription
Ticket/Event ID PathWhere the ID sits in the Create response, for example id, result.sys_id or data[0].id. You pick it from the response already fetched during the test, so no second ticket is created.
URL and MethodThe endpoint shared by Update and Close.
Verify SSL, Data Type and HeadersSame options as in the Create Action.
Update BodySent when the alarm severity changes. Use $ticketId to refer to the saved ID.
Close BodySent when the alarm clears. Update and Close use the same endpoint and differ only by body.
Ticket Settings
FieldDescription
SubjectThe subject template for the ticket. Type $ to insert replaceable tags.
SeveritiesSelect the alarm severities that create a ticket. Other severities are skipped.
TagsOptional. Type a tag and press Enter to add it.
Resolve AutomaticallyWhen enabled, Cloudmon closes the ticket when the alarm clears.
Severity Value Mappings

Add named rows that map each Cloudmon severity (Down, Critical, Trouble and Attention) to the value your tool expects. Each row becomes its own $name tag, available in the $ picker as you type. Add several rows when your tool needs separately scaled fields, such as ServiceNow's Impact and Urgency.

Step 2: Enable in Notification Profile

1
Open the Notification Profile you want to use, or create a new one.
2
Add the saved Custom Integration to the profile, the same way you add other integrations.
3
Click Save.

When an alarm covered by this profile fires, Cloudmon runs the integration automatically.

Replaceable Tags

All standard alarm and device tags work in every body field, for example $device_name, $device_ip, $severity, $message, $title, $description, $category, $status and $customer. Custom Integration adds these:

TagResolves To
$subjectThe Ticket Settings Subject template, with its tags already filled in.
$tagsThe Ticket Settings tags, comma-separated.
$severityPriorityBuilt-in priority on the Freshdesk and Freshservice scale, from 1 (Low) to 4 (Urgent).
$alarmHtmlThe rich HTML alarm card used in Freshdesk and Freshservice tickets and in alarm emails. A simpler card is used when full alarm data is unavailable, such as during Test Connection.
$<mapping name>Any Severity Value Mapping you created, for example $impact or $urgency.
$ticketIdManage action only. The ID extracted from the Create response using the Ticket/Event ID Path.
Quoting rule: Put the tag inside the quotes for text fields. Use it without quotes for numeric fields.
{
"subject": "$subject",
"priority": $severityPriority
}

Example: Incident Management with Freshdesk

An illustrative Create body. Field names depend on your tool's API, so check its documentation.

{
"subject": "$subject",
"description": "$alarmHtml",
"email": "alerts@yourcompany.com",
"priority": $severityPriority,
"status": 2
}

Troubleshooting

IssueResolution
Manage Action is lockedRun Test Connection successfully first.
Ticket ID is not foundPick the Ticket/Event ID Path again from the test response, and check that it matches the response exactly.
Test fails with an unknown-field errorThe test sends your real body, so remove or rename fields your tool does not accept.
Certificate errorCheck that the URL has a valid SSL certificate. Turn off Verify SSL Certificate only for trusted internal systems.
Some alarms do not create ticketsCheck the Severities filter in Ticket Settings.
Custom Integration is not visibleIt is not available on Basic and Standard plans, the same as Custom Hook.
Need help?
Our support team can help you configure an integration. Raise a ticket or use the ChatBot in the Support Center.