Getting Started

From sign-in to your first alert in about five minutes. You'll create an integration API key, fire a test alert with curl, and watch it land in the console.

1. Sign in to the admin console

   Open your OpsPing URL and sign in with your team account email and password. If your organization has SSO configured, the SSO option appears below the form.

   

2. Get your bearings on the dashboard

   After login you land on the dashboard: open and acknowledged alerts, open incidents, degraded services, recent alerts, and who is on call right now. On a fresh workspace most cards read zero — that's expected.

   

   Tip

   The console ships with a dark theme. Switch themes from the Theme control at the bottom of the sidebar — your preference is remembered per browser.

3. Run the onboarding wizard on first sign-in

   The first time you sign in, OpsPing offers a six-step onboarding wizard that walks you through the people-side of setup — inviting your team, creating your first schedule, and sending a test alert. It's the fastest path to a working workspace. Prefer to drive manually? Skip it and use the steps below.

   

   Note

   The wizard covers the setup the alert steps below assume is done — teammates to page and a schedule that decides who's on call. You can re-enter it any time from the console.

4. Create an integration

   Go to Integrations in the sidebar and click New Integration. Give it a name that identifies the source (e.g. prometheus-prod), pick a type, and set the scopes the key needs. For sending alerts, write is the scope that matters; add read/delete only if the tool also queries or closes alerts through the API.

   

5. Copy the API key — now

   OpsPing shows the generated API key exactly once, immediately after creation. Copy it into your secrets manager before closing the dialog.

   Warning

   The key is stored hashed and cannot be recovered later. If you lose it, regenerate the key on the integration — the old key stops working the moment the new one is issued.

6. Send your first alert

   Authenticate with the OpsPingKey scheme and post an alert:

   curl -X POST https://api.ops-ping.com/v2/alerts \
     -H "Authorization: OpsPingKey YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"message": "Test alert — setup complete", "priority": "P3"}'

   A 202 response with a body like {"result":"Request will be processed","alertId":"…"} means it's in. 401 means the key is wrong or missing the write scope; 429 means you've hit the rate limit — back off and retry.

   Note

   Migrating from Opsgenie? The GenieKey scheme is accepted as an alias for OpsPingKey, so existing tooling keeps working while you migrate. See the Migration guide.

7. See it in the alerts list

   Open Alerts in the sidebar. Your test alert sits at the top in the Open state. Click it to acknowledge, add a note, or close it — the full lifecycle is covered in Alert triage.

   

   You're live. Point your real monitoring tool at the same endpoint and the next alert that fires will page whoever is on call.