Authentication
All API requests require a Bearer token in the Authorization header. You can generate API keys from your Jess dashboard under Settings > API Keys.
Base URL for all endpoints:
Contacts
List all contacts. Supports pagination with
?page=1&limit=50
Create a new contact. Required fields:
name, phone or email
Get a single contact by ID, including conversation history
Update a contact's information
Conversations
List all conversations. Filter with
?status=active or ?contact_id=123
Send a message in an existing conversation. Jess will deliver via the appropriate channel.
Pipeline
Get all pipeline stages and deals
Create a new deal. Required:
contact_id, stage, value
Move a deal to a different stage or update its value
Webhooks
Configure webhooks from your dashboard under Settings > Webhooks. Jess will POST JSON payloads to your URL when events occur.
Available Events
contact.created — New contact addedcontact.updated— Contact information changedconversation.message — New message in any conversationdeal.stage_changed— Deal moved to a new pipeline stagedeal.won — Deal marked as wondeal.lost— Deal marked as lostcontent.published— Content published to a social channel
Webhook Payload Example
Rate Limits
API requests are limited to 100 requests per minute per API key. Webhook deliveries retry 3 times with exponential backoff on failure.
Need Help?
Email [email protected] with your integration questions. For complex integrations, Scale plan customers get priority developer support.