REST API

The base URL is https://buzzmark.chat/api/v1. Every response is JSON. Requests are rate-limited to 120 per minute per token.

Authentication

Create an API token in Settings → Developers. Tokens are shown once and stored hashed - treat them like passwords. Send the token as a bearer header on every request:

Authorization: Bearer bzk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Who am I

Returns the workspace the token belongs to - handy as a connectivity check.

curl https://buzzmark.chat/api/v1/me \
  -H "Authorization: Bearer bzk_…"

Conversations

Lists the workspace's conversations, newest activity first, with channel, status, assignment and contact summary.

A single conversation by its public id, including its messages.

Contacts

Lists contacts across your inboxes.

Creates (or finds) a contact. All fields optional except that at least an email or external id makes it useful:

curl -X POST https://buzzmark.chat/api/v1/contacts \
  -H "Authorization: Bearer bzk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jo@example.com",
    "name": "Jo Bloggs",
    "external_id": "user_42",
    "inbox": "optional-inbox-public-id"
  }'

Ingest a conversation

Turns anything - a contact form, an internal tool, another system - into a conversation in your inbox, threading repeat senders into their existing contact:

curl -X POST https://buzzmark.chat/api/v1/ingest \
  -H "Authorization: Bearer bzk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jo@example.com",
    "name": "Jo Bloggs",
    "subject": "Contact form: pricing question",
    "message": "Hi! Do you offer annual billing?",
    "inbox": "optional-inbox-public-id"
  }'

REST hooks

For no-code connectors (Zapier, Make, IFTTT) - subscribe a URL to an event and we'll POST to it:

{ "target_url": "https://hooks.example.com/abc", "event": "message.created" }

Events: conversation.created and message.created. For signed, dashboard-managed deliveries see webhooks.

Errors

Standard HTTP status codes: 401 for a missing/invalid token, 404 for unknown resources, 422 with a JSON errors object for validation failures, and 429 when you hit the rate limit.