@pushary/server

Server-side SDK for Pushary - Manage subscribers, campaigns, templates, and send push notifications from your backend.

Installation

``bash
npm install @pushary/server


or

yarn add @pushary/server

or

pnpm add @pushary/server

or

bun add @pushary/server
`

Quick Start

`typescript
import { createPusharyServer } from '@pushary/server'

const pushary = createPusharyServer({
apiKey: process.env.PUSHARY_API_KEY,
})

await pushary.notifications.send({
title: 'Hello!',
body: 'Your order has shipped',
subscriberIds: ['sub_123'],
})
`

API Key

The server SDK requires your full API key (pk_xxx.sk_xxx) which includes the secret portion.

Never expose this in client-side code.

Get your API key from your Pushary Dashboard.

Resources

$3

`typescript
const { data, hasMore, nextCursor } = await pushary.subscribers.list({
limit: 100,
status: 'active',
})

const subscriber = await pushary.subscribers.get('sub_123')

await pushary.subscribers.update('sub_123', {
tags: ['vip', 'newsletter'],
externalId: 'user-456',
})

await pushary.subscribers.delete('sub_123')

const count = await pushary.subscribers.count()
`

$3

`typescript
const { data } = await pushary.campaigns.list()

const campaign = await pushary.campaigns.create({
name: 'Welcome Campaign',
title: 'Welcome!',
body: 'Thanks for subscribing',
actionUrl: 'https://example.com/welcome',
})

await pushary.campaigns.send(campaign.id)

await pushary.campaigns.pause(campaign.id)
await pushary.campaigns.resume(campaign.id)

const stats = await pushary.campaigns.stats(campaign.id)
`

$3

`typescript
const { data } = await pushary.templates.list()

const template = await pushary.templates.create({
name: 'Order Update',
title: 'Order {{orderId}} Update',
body: 'Your order status: {{status}}',
})

await pushary.templates.update(template.id, {
body: 'Your order {{orderId}} is now {{status}}',
})

await pushary.templates.delete(template.id)
`

$3

`typescript
await pushary.notifications.send({
title: 'Flash Sale!',
body: '50% off everything',
url: 'https://example.com/sale',
subscriberIds: ['sub_123', 'sub_456'],
})

await pushary.notifications.send({
title: 'New Message',
body: 'You have a new message',
externalIds: ['user-123'],
})

await pushary.notifications.send({
title: 'VIP Exclusive',
body: 'Special offer just for you',
tags: ['vip'],
})
`

TypeScript

Full TypeScript support with exported types:

`typescript
import {
createPusharyServer,
type Subscriber,
type Campaign,
type Template,
type SendNotification,
} from '@pushary/server'
`

Security

- API keys are site-scoped (each site has isolated VAPID keys)
- Keys should be stored in environment variables
- Rotate keys via dashboard if compromised

License

MIT. See LICENSE`.