API Overview

Overview

The Murmurd API will enable you to:

Programmatically manage teams and users
Submit check-ins from custom tools
Create and track escalations
Access summary data
Build custom integrations

Planned Features

REST API

Standard RESTful endpoints for all core resources:

GET    /api/v1/teams
POST   /api/v1/teams
GET    /api/v1/teams/:id
PUT    /api/v1/teams/:id
DELETE /api/v1/teams/:id

GET    /api/v1/checkins
POST   /api/v1/checkins
GET    /api/v1/checkins/:id

GET    /api/v1/escalations
POST   /api/v1/escalations
PUT    /api/v1/escalations/:id

GET    /api/v1/priorities
POST   /api/v1/priorities
PUT    /api/v1/priorities/:id

GET    /api/v1/summaries
GET    /api/v1/summaries/:id

Webhooks

Subscribe to events:

checkin.created
checkin.submitted
escalation.created
escalation.resolved
priority.set
priority.completed
summary.generated

Authentication

API access will use:

API Keys: For server-to-server integration
OAuth 2.0: For user-authorized access
JWT Tokens: For authenticated sessions

Use Cases

Custom Check-in Tools

Build check-ins into your existing tools:

// Example: Submit check-in from CLI tool
const response = await fetch('https://api.murmurd.com/v1/checkins', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    teamId: 'team_123',
    responses: [
      { questionId: 'q_1', answer: 'Shipped the new feature' },
      { questionId: 'q_2', answer: 'Working on tests' }
    ],
    visibility: 'TEAM'
  })
});

BI Integration

Export data to your analytics tools:

// Example: Fetch team metrics
const metrics = await fetch(
  'https://api.murmurd.com/v1/teams/team_123/metrics?period=30d',
  { headers: { 'Authorization': 'Bearer YOUR_API_KEY' } }
);

const data = await metrics.json();
// { responseRate: 0.94, avgResponseTime: '45m', ... }

CI/CD Integration

Create escalations from build failures:

// Example: Auto-escalate on deployment failure
if (deploymentFailed) {
  await fetch('https://api.murmurd.com/v1/escalations', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      teamId: 'team_123',
      description: 'Deployment to production failed',
      visibility: 'TEAM'
    })
  });
}

Rate Limits

Planned rate limits:

Plan	Requests/minute
Pro	100
Enterprise	1000

Coming Soon

We’re actively developing:

Core endpoints - Teams, users, check-ins
Webhook system - Real-time event notifications
SDK libraries - JavaScript, Python, Go
OpenAPI spec - Full API documentation

Stay Updated

Want early access or have specific requirements?

Email: api@murmurd.com
Enterprise: Custom API access available now