Skip to content
OpsFusion

API Overview

The OpsFusion API allows you to programmatically send alerts to your on-call teams. This enables integration with monitoring tools, custom applications, and automation workflows.

Getting Started

Section titled “Getting Started”

To use the API, you’ll need:

  1. An API key - Authenticate your requests (Create an API Key)
  2. Account ID - Your OpsFusion account identifier
  3. Team ID - The team that should receive the alerts
  4. HTTP client - Any tool or library that can make HTTPS requests

Finding Your Account ID and Team ID

Section titled “Finding Your Account ID and Team ID”

Account ID:

  1. Log in to OpsFusion
  2. Click on your name at the top-right corner and select Account
  3. Your Account ID is displayed in the Account Details

Team ID:

  1. Navigate to Teams
  2. Click on the team you want to send alerts to
  3. Click on Settings and the team ID is displayed in the menu

Team settings tile

Quick Start Guide

Section titled “Quick Start Guide”

Send your first alert with our quickstart guide. Review the Send Alerts documentation for complete instructions, code examples, and API reference.

API Documentation Structure

Section titled “API Documentation Structure”

Our API documentation is organized into the following sections:

Create an API Key

Section titled “Create an API Key”

Step-by-step guide to generating API keys in the OpsFusion dashboard.

Send Alerts

Section titled “Send Alerts”

Complete API reference including:

  • Two alert formats: Standard and Alertmanager
  • Endpoint details and path parameters
  • Request/response formats
  • Response codes and error handling
  • Code examples in Python, Node.js, Go, and cURL

Integrations

Section titled “Integrations”

Setup guides for sending alerts from specific monitoring, observability, and ITSM tools — Prometheus Alertmanager, AWS CloudWatch, Datadog, Dynatrace, Freshservice, Grafana Alerting, New Relic, SolarWinds Observability, and Zabbix.

Base URL

Section titled “Base URL”

All API requests should be made to:

https://api.opsfusion.cloud/v1

Authentication

Section titled “Authentication”

OpsFusion uses API key authentication. The API uses a custom authorizer that validates API keys against your account.

Include your API key in the Authorization header:

Authorization: YOUR_API_KEY

Rate Limits

Section titled “Rate Limits”

API requests are rate limited to ensure service stability. If you exceed the rate limit, you’ll receive a 429 Too Many Requests response.

Best Practice: Implement exponential backoff retry logic for rate-limited requests.

API Versions

Section titled “API Versions”

The current API version is v1. We maintain backwards compatibility and will announce any breaking changes well in advance.

Support

Section titled “Support”

For API support:

Next Steps

Section titled “Next Steps”
  1. Create an API key in your OpsFusion account
  2. Review the Send Alerts reference documentation
  3. Integrate OpsFusion with your monitoring systems