API Documentation

API Key Types

• Account Keys - Can send to any channel in your account
• Channel Keys - Restricted to a specific channel only

Optional Parameters

iOS-Specific Parameters

Android-Specific Parameters

Customization Parameters

Targeting ParametersGrowth plan

Send to specific subscribers or groups instead of all channel subscribers. Omit both parameters to send to everyone.

Optional Parameters

Node.js

const response = await fetch('https://chirpme.app/api/send', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    channelId: 'your-channel-id',
    title: 'Hello World',
    body: 'This is a test notification',
    url: 'https://example.com',
    detail: '<p>Rich HTML content for detail view</p>',
    imageUrl: 'https://example.com/image.png',
    scheduledAt: '2025-01-15T10:00:00Z',
    // iOS options
    badge: 1,
    sound: 'default',
    category: 'general',
    threadId: 'thread-123',
    // Android options
    priority: 'high',
    color: '#2dd4bf',
    tag: 'notification-tag',
    // Icon override
    notificationIcon: 'notifications',
    notificationIconType: 'material', // or 'url'
    // Sub-tab suggestion
    suggestedSubTab: 'Updates',
    suggestedSubTabColor: '#2dd4bf',
    // Targeting (Growth plan)
    to: ['user1@example.com', 'user2@example.com'],
    groups: ['group-id-1'],
  }),
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.post(
    'https://chirpme.app/api/send',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json',
    },
    json={
        'channelId': 'your-channel-id',
        'title': 'Hello World',
        'body': 'This is a test notification',
        'url': 'https://example.com',
        'detail': '<p>Rich HTML content for detail view</p>',
        'imageUrl': 'https://example.com/image.png',
        'scheduledAt': '2025-01-15T10:00:00Z',
        # iOS options
        'badge': 1,
        'sound': 'default',
        'category': 'general',
        'threadId': 'thread-123',
        # Android options
        'priority': 'high',
        'color': '#2dd4bf',
        'tag': 'notification-tag',
        # Icon override
        'notificationIcon': 'notifications',
        'notificationIconType': 'material',  # or 'url'
        # Sub-tab suggestion
        'suggestedSubTab': 'Updates',
        'suggestedSubTabColor': '#2dd4bf',
        # Targeting (Growth plan)
        'to': ['user1@example.com', 'user2@example.com'],
        'groups': ['group-id-1'],
    }
)

data = response.json()
print(data)

C#

using System.Net.Http;
using System.Text;
using System.Text.Json;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer YOUR_API_KEY");

var payload = new {
    channelId = "your-channel-id",
    title = "Hello World",
    body = "This is a test notification",
    url = "https://example.com",
    detail = "<p>Rich HTML content for detail view</p>",
    imageUrl = "https://example.com/image.png",
    scheduledAt = "2025-01-15T10:00:00Z",
    // iOS options
    badge = 1,
    sound = "default",
    category = "general",
    threadId = "thread-123",
    // Android options
    priority = "high",
    color = "#2dd4bf",
    tag = "notification-tag",
    // Icon override
    notificationIcon = "notifications",
    notificationIconType = "material", // or "url"
    // Sub-tab suggestion
    suggestedSubTab = "Updates",
    suggestedSubTabColor = "#2dd4bf",
    // Targeting (Growth plan)
    to = new[] { "user1@example.com", "user2@example.com" },
    groups = new[] { "group-id-1" }
};

var content = new StringContent(
    JsonSerializer.Serialize(payload),
    Encoding.UTF8,
    "application/json"
);

var response = await client.PostAsync(
    "https://chirpme.app/api/send",
    content
);

var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

Node.js

const response = await fetch('https://chirpme.app/api/channels', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Product Updates',
    description: 'Get notified about new features and product updates',
    code: 'PROD-2024',
    icon: 'notifications',
    iconType: 'material',
    isPublic: false,
  }),
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.post(
    'https://chirpme.app/api/channels',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json',
    },
    json={
        'name': 'Product Updates',
        'description': 'Get notified about new features and product updates',
        'code': 'PROD-2024',
        'icon': 'notifications',
        'iconType': 'material',
        'isPublic': False,
    }
)

data = response.json()
print(data)

C#

using System.Net.Http;
using System.Text;
using System.Text.Json;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer YOUR_API_KEY");

var payload = new {
    name = "Product Updates",
    description = "Get notified about new features and product updates",
    code = "PROD-2024",
    icon = "notifications",
    iconType = "material",
    isPublic = false
};

var content = new StringContent(
    JsonSerializer.Serialize(payload),
    Encoding.UTF8,
    "application/json"
);

var response = await client.PostAsync(
    "https://chirpme.app/api/channels",
    content
);

var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

Node.js

// List groups
const groups = await fetch(
  'https://chirpme.app/api/groups?channelId=your-channel-id',
  {
    headers: { 'Authorization': 'Bearer YOUR_API_KEY' },
  }
);
console.log(await groups.json());

// Create a group
const newGroup = await fetch('https://chirpme.app/api/groups', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    channelId: 'your-channel-id',
    name: 'VIP Subscribers',
    memberEmails: ['user1@example.com', 'user2@example.com'],
  }),
});
console.log(await newGroup.json());

Python

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
}

# List groups
groups = requests.get(
    'https://chirpme.app/api/groups',
    headers=headers,
    params={'channelId': 'your-channel-id'}
)
print(groups.json())

# Create a group
new_group = requests.post(
    'https://chirpme.app/api/groups',
    headers=headers,
    json={
        'channelId': 'your-channel-id',
        'name': 'VIP Subscribers',
        'memberEmails': ['user1@example.com', 'user2@example.com'],
    }
)
print(new_group.json())

C#

using System.Net.Http;
using System.Text;
using System.Text.Json;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer YOUR_API_KEY");

// List groups
var listResponse = await client.GetAsync(
    "https://chirpme.app/api/groups?channelId=your-channel-id"
);
Console.WriteLine(await listResponse.Content.ReadAsStringAsync());

// Create a group
var payload = new {
    channelId = "your-channel-id",
    name = "VIP Subscribers",
    memberEmails = new[] { "user1@example.com", "user2@example.com" }
};

var content = new StringContent(
    JsonSerializer.Serialize(payload),
    Encoding.UTF8,
    "application/json"
);

var createResponse = await client.PostAsync(
    "https://chirpme.app/api/groups",
    content
);
Console.WriteLine(await createResponse.Content.ReadAsStringAsync());

Node.js

// Start a live activity (all subscribers)
const start = await fetch('https://chirpme.app/api/live-activities', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    channelId: 'your-channel-id',
    templateType: 'percentage_bar',
    title: 'Order Processing',
    fields: { percentage: '0', label: 'Preparing your order...' },
    // Targeting (Growth plan) — omit for all subscribers
    // targetType: 'subscribers',
    // targetSubscribers: ['user@example.com'],
    // targetType: 'groups',
    // targetGroups: ['group-id-1'],
  }),
});
const { liveActivity } = await start.json();
console.log('Activity ID:', liveActivity.id);

// Update the live activity
await fetch('https://chirpme.app/api/live-activities', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    activityId: liveActivity.id,
    channelId: 'your-channel-id',
    fields: { percentage: '75', label: 'Almost ready!' },
  }),
});

// End the live activity
await fetch(`https://chirpme.app/api/live-activities/${liveActivity.id}`, {
  method: 'DELETE',
  headers: { 'Authorization': 'Bearer YOUR_API_KEY' },
});

Python

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
}

# Start a live activity (all subscribers)
start = requests.post(
    'https://chirpme.app/api/live-activities',
    headers=headers,
    json={
        'channelId': 'your-channel-id',
        'templateType': 'percentage_bar',
        'title': 'Order Processing',
        'fields': {'percentage': '0', 'label': 'Preparing your order...'},
        # Targeting (Growth plan) — omit for all subscribers
        # 'targetType': 'subscribers',
        # 'targetSubscribers': ['user@example.com'],
        # 'targetType': 'groups',
        # 'targetGroups': ['group-id-1'],
    }
)
activity_id = start.json()['liveActivity']['id']
print('Activity ID:', activity_id)

# Update the live activity
requests.put(
    'https://chirpme.app/api/live-activities',
    headers=headers,
    json={
        'activityId': activity_id,
        'channelId': 'your-channel-id',
        'fields': {'percentage': '75', 'label': 'Almost ready!'},
    }
)

# End the live activity
requests.delete(
    f'https://chirpme.app/api/live-activities/{activity_id}',
    headers=headers
)

C#

using System.Net.Http;
using System.Text;
using System.Text.Json;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer YOUR_API_KEY");

// Start a live activity (all subscribers)
var startPayload = new {
    channelId = "your-channel-id",
    templateType = "percentage_bar",
    title = "Order Processing",
    fields = new { percentage = "0", label = "Preparing your order..." },
    // Targeting (Growth plan) — omit for all subscribers
    // targetType = "subscribers",
    // targetSubscribers = new[] { "user@example.com" },
    // targetType = "groups",
    // targetGroups = new[] { "group-id-1" }
};

var startContent = new StringContent(
    JsonSerializer.Serialize(startPayload),
    Encoding.UTF8,
    "application/json"
);

var startResponse = await client.PostAsync(
    "https://chirpme.app/api/live-activities",
    startContent
);
var startResult = JsonSerializer.Deserialize<JsonElement>(
    await startResponse.Content.ReadAsStringAsync()
);
var activityId = startResult.GetProperty("liveActivity").GetProperty("id").GetString();

// Update the live activity
var updatePayload = new {
    activityId,
    channelId = "your-channel-id",
    fields = new { percentage = "75", label = "Almost ready!" }
};
var updateContent = new StringContent(
    JsonSerializer.Serialize(updatePayload),
    Encoding.UTF8,
    "application/json"
);
await client.PutAsync("https://chirpme.app/api/live-activities", updateContent);

// End the live activity
await client.DeleteAsync($"https://chirpme.app/api/live-activities/{activityId}");