Get a threshold notification

curl --request POST \
  --url https://api.metronome.com/v1/customer-alerts/get \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "9b85c1c1-5238-4f2a-a409-61412905e1e1",
  "alert_id": "8deed800-1b7a-495d-a207-6c52bac54dc9"
}
'

import requests

url = "https://api.metronome.com/v1/customer-alerts/get"

payload = {
    "customer_id": "9b85c1c1-5238-4f2a-a409-61412905e1e1",
    "alert_id": "8deed800-1b7a-495d-a207-6c52bac54dc9"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
    alert_id: '8deed800-1b7a-495d-a207-6c52bac54dc9'
  })
};

fetch('https://api.metronome.com/v1/customer-alerts/get', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.metronome.com/v1/customer-alerts/get",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer_id' => '9b85c1c1-5238-4f2a-a409-61412905e1e1',
    'alert_id' => '8deed800-1b7a-495d-a207-6c52bac54dc9'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.metronome.com/v1/customer-alerts/get"

	payload := strings.NewReader("{\n  \"customer_id\": \"9b85c1c1-5238-4f2a-a409-61412905e1e1\",\n  \"alert_id\": \"8deed800-1b7a-495d-a207-6c52bac54dc9\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.metronome.com/v1/customer-alerts/get")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"9b85c1c1-5238-4f2a-a409-61412905e1e1\",\n  \"alert_id\": \"8deed800-1b7a-495d-a207-6c52bac54dc9\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.metronome.com/v1/customer-alerts/get")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": \"9b85c1c1-5238-4f2a-a409-61412905e1e1\",\n  \"alert_id\": \"8deed800-1b7a-495d-a207-6c52bac54dc9\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "customer_status": "in_alarm",
    "alert": {
      "id": "8deed800-1b7a-495d-a207-6c52bac54dc9",
      "uniqueness_key": "823j7fqzo1",
      "name": "Low credit balance alert",
      "type": "low_credit_balance_reached",
      "status": "enabled",
      "credit_type": {
        "id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
        "name": "USD (cents)"
      },
      "threshold": 0,
      "updated_at": "2022-01-01T00:00:00Z"
    }
  }
}

{
  "message": "<string>"
}

Notifications

Get a threshold notification

Retrieve the real-time evaluation status for a specific threshold notification-customer pair. This endpoint provides instant visibility into whether a customer has triggered a threshold notification condition, enabling you to monitor account health and take proactive action based on current threshold notification states.

Use this endpoint to:

Check if a specific customer is currently violating an threshold notification (in_alarm status)
Verify threshold notification configuration details and threshold values for a customer
Monitor the evaluation state of newly created or recently modified threshold notification
Build dashboards or automated workflows that respond to specific threshold notification conditions
Validate threshold notification behavior before deploying to production customers
Integrate threshold notification status checks into customer support tools or admin interfaces

Key response fields:

A CustomerAlert object containing:

customer_status: The current evaluation state
ok - Customer is within acceptable thresholds
in_alarm - Customer has breached the threshold for the notification
evaluating - Notification is currently being evaluated (typically during initial setup)
null - Notification has been archived
triggered_by: Additional context about what caused the notification to trigger (when applicable)
updated_at: Timestamp of when the customer_status was last updated
alert: Complete threshold notification configuration including:
- Notification ID, name, and type
- Current threshold values and credit type information
- Notification status (enabled, disabled, or archived)
- Any applied filters (credit grant types, custom fields, group values)

Usage guidelines:

Customer status: Returns the current evaluation state, not historical data. For threshold notification history, use webhook notifications or event logs
Required parameters: Both customer_id and alert_id must be valid UUIDs that exist in your organization
Archived notifications: Returns null for customer_status if the notification has been archived, but still includes the notification configuration details
Performance considerations: This endpoint queries live evaluation state, making it ideal for real-time monitoring but not for bulk status checks
Integration patterns: Best used for on-demand status checks in response to user actions or as part of targeted monitoring workflows
Error handling: Returns 404 if either the customer or alert_id doesn’t exist or isn’t accessible to your organization

POST

customer-alerts

get

Get a threshold notification

curl --request POST \
  --url https://api.metronome.com/v1/customer-alerts/get \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "9b85c1c1-5238-4f2a-a409-61412905e1e1",
  "alert_id": "8deed800-1b7a-495d-a207-6c52bac54dc9"
}
'

import requests

url = "https://api.metronome.com/v1/customer-alerts/get"

payload = {
    "customer_id": "9b85c1c1-5238-4f2a-a409-61412905e1e1",
    "alert_id": "8deed800-1b7a-495d-a207-6c52bac54dc9"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
    alert_id: '8deed800-1b7a-495d-a207-6c52bac54dc9'
  })
};

fetch('https://api.metronome.com/v1/customer-alerts/get', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.metronome.com/v1/customer-alerts/get",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer_id' => '9b85c1c1-5238-4f2a-a409-61412905e1e1',
    'alert_id' => '8deed800-1b7a-495d-a207-6c52bac54dc9'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.metronome.com/v1/customer-alerts/get"

	payload := strings.NewReader("{\n  \"customer_id\": \"9b85c1c1-5238-4f2a-a409-61412905e1e1\",\n  \"alert_id\": \"8deed800-1b7a-495d-a207-6c52bac54dc9\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.metronome.com/v1/customer-alerts/get")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"9b85c1c1-5238-4f2a-a409-61412905e1e1\",\n  \"alert_id\": \"8deed800-1b7a-495d-a207-6c52bac54dc9\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.metronome.com/v1/customer-alerts/get")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": \"9b85c1c1-5238-4f2a-a409-61412905e1e1\",\n  \"alert_id\": \"8deed800-1b7a-495d-a207-6c52bac54dc9\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "customer_status": "in_alarm",
    "alert": {
      "id": "8deed800-1b7a-495d-a207-6c52bac54dc9",
      "uniqueness_key": "823j7fqzo1",
      "name": "Low credit balance alert",
      "type": "low_credit_balance_reached",
      "status": "enabled",
      "credit_type": {
        "id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
        "name": "USD (cents)"
      },
      "threshold": 0,
      "updated_at": "2022-01-01T00:00:00Z"
    }
  }
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The customer ID and notification ID of the threshold notification to get

customer_id

string<uuid>

required

The Metronome ID of the customer

alert_id

string<uuid>

required

The Metronome ID of the threshold notification

group_values

object[]

Only present for spend_threshold_reached notifications. Retrieve the notification for a specific group key-value pair.

Show child attributes

seat_filter

object

Only allowed for low_remaining_seat_balance_reached notifications. This filters alerts by the seat group key-value pair.

Show child attributes

alert_specifiers

object[]

Can be used with only low_remaining_contract_credit_and_commit_balance_reached notifications. Used to filter the alert by the custom field key-value pair.

Show child attributes

Response

Success

data

object

required

Show child attributes

Create a threshold notification

Get all threshold notifications

⌘I

GET STARTED

ESSENTIALS

ENDPOINTS

Get a threshold notification

Use this endpoint to:

Key response fields:

Usage guidelines:

Authorizations

Body

Response