API Reference

Build on Bliizo

A REST API for every resource, a JavaScript SDK for the widget, and webhooks for everything in between. Versioned and documented, because you deserve better than guesswork.

Quick example

Send your first message in 30 seconds

Grab an API key from your dashboard, then curl the send endpoint. That's it.

  • REST over HTTPS
  • Bearer token authentication
  • Predictable JSON responses
  • 1,000 requests / minute default rate limit
terminal — zsh 
# Send a message
curl https://api.bliizo.com/v1/messages \
  -H "Authorization: Bearer $BLIIZO_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "conversation_id": "conv_abc123",
    "body": "Thanks for reaching out!",
    "sender": "agent"
  }'

API resources

Conversations

Create, list, update, and close conversations

View docs →
GET /v1/conversations POST /v1/conversations GET /v1/conversations/{id} PATCH /v1/conversations/{id}

Messages

Send and retrieve messages within conversations

View docs →
GET /v1/messages POST /v1/messages GET /v1/messages/{id}

Contacts

Manage the people your team chats with

View docs →
GET /v1/contacts POST /v1/contacts PATCH /v1/contacts/{id} DELETE /v1/contacts/{id}

Agents

Invite teammates and manage roles

View docs →
GET /v1/agents POST /v1/agents/invite

Webhooks

Receive real-time events

View docs →
GET /v1/webhooks POST /v1/webhooks DELETE /v1/webhooks/{id}

Official libraries

N
Node.js
npm install @bliizo/node
P
Python
pip install bliizo
P
PHP
composer require bliizo/php
R
Ruby
gem install bliizo