Skip to main content
Programmatic access to Vendschat for custom backends, internal tools, and scripted workflows. Who this is for: Developers on Advanced plan (Developer API). Paths:
  • API Keys: Settings → Workspace → API Keys (/settings/workspace/api-keys)
  • REST API reference: Settings → Workspace → REST API (/settings/workspace/rest-api)

​
Quick reference

Plan: Developer API is Advanced only. See billing.

​
API Keys page

Title: API Keys — “Create and manage API keys for accessing your account programmatically.”

​
Create API key flow

  1. Click Create API key (+)
  2. Name (required) — e.g. Nightly reporting job
  3. Expires at (optional) — leave blank for no expiry
  4. Submit → success step shows full key once
  5. Copy and store in secrets manager — list view shows masked keys only
After create: You cannot copy the full key again from the table. Create a new key if lost.

​
Manage keys

​
REST API reference page

Title: REST API — “Complete reference for Vendschat REST API endpoints and authentication.”

​
Getting started block

Rate limit (shown in UI): 1000 requests per hour per API key.

​
Endpoint sections (in-app reference)

The REST API page documents these resource groups:

​
Authentication

Note: Production integrations typically use API keys from API Keys settings rather than login, unless your use case requires user-scoped tokens.

​
Messages

​
Users

​
Channels

​
Webhooks (API-managed)

You can also manage webhooks in Settings → Webhooks UI on Growth+ without using the REST API.

​
Example: FlowMetrics nightly job

FlowMetrics (B2B SaaS on Advanced) runs a cron job:
  1. API Keys → create Executive dashboard sync
  2. Copy key to server env VENDSCHAT_API_KEY
  3. GET https://api.vendschat.com/v1/messages?channel_id=… with Bearer header
  4. Aggregate open thread metrics → internal BI tool
They never embed the key in frontend JavaScript.

​
API vs webhooks vs integrations catalog

*Confirm HubSpot on your tier in billing docs.

​
Security practices

  • Advanced plan only — do not share API keys with Starter/Growth-only workspaces expecting API access
  • One key per service — revoke when decommissioning
  • Set expiry for contractors or short projects
  • Never commit keys to git or paste in Chat
  • Respect 1000 req/hr — backoff on 429 responses
  • Prefer API keys over storing user passwords for /auth/login

​
Troubleshooting

​
Custom API card (Integrations catalog)

Settings → Integrations → Custom API
  • Status: Setup needed (warning)
  • View Docs → REST API page
  • Configure → API Keys / setup flow