Common Tasks

All Chirpier SDKs expose helpers around the same resource model. These examples show the most common operations beyond logging.

Resolve an event definition

After logging, use listEvents to find the event definition and get the event_id needed for analytics, policies, and sharing.

JavaScript


const events = await client.listEvents();
const event = events.find(
  (e) => e.agent === "openclaw.main" && e.event === "task.duration_ms",
);

Python


events = client.list_events()
event = next(
    (e for e in events if e.get("agent") == "openclaw.main" and e.get("event") == "task.duration_ms"),
    None,
)

Go


events, _ := client.ListEvents(ctx)
for _, e := range events {
    if e.Agent == "openclaw.main" && e.Event == "task.duration_ms" {
        // use e.EventID
    }
}

Query analytics comparisons

Use analytics windows to compare the current period against a previous one.

JavaScript


const analytics = await client.getEventAnalytics(eventID, {
  view: "window",
  period: "1h",
  previous: "previous_1d",
});
 
// analytics.data.value_pct_change shows % change vs same hour yesterday

Python


analytics = client.get_event_analytics(
    event_id,
    view="window",
    period="1h",
    previous="previous_1d",
)
 
# analytics["data"]["value_pct_change"] shows % change vs same hour yesterday

Go


analytics, _ := client.GetEventAnalytics(ctx, eventID, chirpier.AnalyticsWindowQuery{
    View:     "window",
    Period:   "1h",
    Previous: "previous_1d",
})
 
// analytics.Data.ValuePctChange shows % change vs same hour yesterday

Create a policy

Policies define alert conditions. Choose the aggregate based on the event shape.

JavaScript


const policy = await client.createPolicy({
  event_id: eventID,
  title: "High error rate",
  channel: "ops",
  period: "hour",
  aggregate: "sum",
  condition: "gt",
  threshold: 50,
  severity: "warning",
  enabled: true,
});

Python


policy = client.create_policy({
    "event_id": event_id,
    "title": "High error rate",
    "channel": "ops",
    "period": "hour",
    "aggregate": "sum",
    "condition": "gt",
    "threshold": 50,
    "severity": "warning",
    "enabled": True,
})

Go


policy, _ := client.CreatePolicy(ctx, chirpier.Policy{
    EventID:   eventID,
    Title:     "High error rate",
    Channel:   "ops",
    Period:    "hour",
    Aggregate: "sum",
    Condition: "gt",
    Threshold: 50,
    Severity:  "warning",
    Enabled:   true,
})

Set up a destination and test it

Create a destination, send a test notification, and inspect the delivery.

JavaScript


const destination = await client.createDestination({
  channel: "slack",
  url: "https://hooks.slack.com/services/T000/B000/secret",
  scope: "all",
  policy_ids: [],
  enabled: true,
});
 
const test = await client.testDestination(destination.destination_id);
const deliveries = await client.getAlertDeliveries(test.alert_id, { kind: "test" });

Python


destination = client.create_destination({
    "channel": "slack",
    "url": "https://hooks.slack.com/services/T000/B000/secret",
    "scope": "all",
    "policy_ids": [],
    "enabled": True,
})
 
test = client.test_destination(destination["destination_id"])
deliveries = client.get_alert_deliveries(test["alert_id"], kind="test")

Go


destination, _ := client.CreateDestination(ctx, chirpier.Destination{
    Channel:   "slack",
    URL:       "https://hooks.slack.com/services/T000/B000/secret",
    Scope:     "all",
    PolicyIDs: []string{},
    Enabled:   true,
})
 
test, _ := client.TestDestination(ctx, destination.DestinationID)
deliveries, _ := client.GetAlertDeliveries(ctx, test.AlertID, 0, 0, "test")

Triage an alert

Read an alert, inspect deliveries, and move it through the lifecycle.

JavaScript


const alerts = await client.listAlerts("triggered");
 
for (const alert of alerts) {
  const deliveries = await client.getAlertDeliveries(alert.alert_id, { kind: "alert" });
  // inspect deliveries...
 
  await client.acknowledgeAlert(alert.alert_id);
  // later: await client.resolveAlert(alert.alert_id);
}

Python


alerts = client.list_alerts(status="triggered")
 
for alert in alerts:
    deliveries = client.get_alert_deliveries(alert["alert_id"], kind="alert")
    # inspect deliveries...
 
    client.acknowledge_alert(alert["alert_id"])
    # later: client.resolve_alert(alert["alert_id"])

Go


alerts, _ := client.ListAlerts(ctx, "triggered")
 
for _, alert := range alerts {
    deliveries, _ := client.GetAlertDeliveries(ctx, alert.AlertID, 0, 0, "alert")
    // inspect deliveries...
 
    _, _ = client.AcknowledgeAlert(ctx, alert.AlertID)
    // later: client.ResolveAlert(ctx, alert.AlertID)
}

When to use SDK helpers

Use the SDK helpers when you want one authenticated client for both:

Logging event data
Managing Chirpier resources

Use raw HTTP when you need language-agnostic integrations, shell automation, or direct infrastructure-level control.

For endpoint-by-endpoint behavior, see API Reference.