Garmingo Docs

Create an Integration

Step-by-step flow for adding a new integration and scoping it to monitors.

This guide explains the creation flow, validation steps, and field semantics for adding a new integration (alert channel).

Steps

  1. Choose integration type (e.g., Slack, Email, Webhook).
  2. Provide channel‑specific configuration (URL, token, address, phone number, etc.).
  3. Select scope: All monitors OR specific monitors.
  4. (Optional) Set initial active state (default: active once valid).
  5. Save & complete any validation (email link, test ping, etc.).

Email Verification Flow

  1. You submit the email address.
  2. A code & signed link are sent.
  3. Clicking link activates and marks the address verified.

Webhook Delivery

Generic webhooks send JSON payloads with event metadata (sample structure will be documented per endpoint in a future update). Expect retries for transient failures in later versions (current version may log failures only).

Choosing Scope

  • Prefer targeted monitors for low‑urgency channels (e.g., project chat rooms).
  • Use All monitors only for high‑severity paging channels (SMS, OpsGenie).

Post‑Creation Testing

  • Trigger a test notification (where supported) or temporarily toggle a non‑critical monitor.
  • For heartbeat / manual monitors, you can manually flip status to validate notification flow.

Governance Tips

  • Prefix names with environment ("[PROD] Slack Alerts").
  • Maintain a runbook documenting who owns each integration.

Removal vs Deactivation

  • Deactivate (set active false) to pause temporarily.
  • Remove to permanently revoke credentials (do this promptly for compromised tokens).