Access to the Contacts API is controlled via API keys or OAuth tokens with the scope set to readonly (contacts.readonly). Include your token in the Authorization header of each request.
Callbell connects to the Contacts API using secure credentials. Store keys safely, rotate them regularly, and apply the necessary scope to limit access to read-only contact data where appropriate.
GET /contacts/:contactId; GET /contacts/:contactId/tasks; GET /contacts/:contactId/tasks/:taskId; GET /contacts/:contactId/notes; GET /contacts/:contactId/notes/:id; GET /contacts/:contactId/appointments; GET /contacts/; GET /contacts/business/:businessId; POST /contacts/; PUT /contacts/:contactId; DELETE /contacts/:contactId; POST /contacts/:contactId/tasks; PUT /contacts/:contactId/tasks/:taskId; PUT /contacts/:contactId/tasks/:taskId/completed; DELETE /contacts/:contactId/tasks/:taskId; POST /contacts/:contactId/tags
Trigger: when a contact is viewed or created in Callbell, retrieve the contact profile from the Contacts API.
Actions: pull contact details, tasks, notes, and appointments to enrich the conversation with context.
GET /contacts/:contactId
Key fields: contactId, name, email, phone
Trigger: updates to a task in Callbell should propagate to the Contacts API.
Actions: create, update, or delete tasks; mark tasks as completed to keep both systems aligned.
PUT /contacts/:contactId/tasks/:taskId
Key fields: contactId, taskId, status, description
Trigger: when a contact is removed or tags are updated in Callbell, reflect changes in the Contacts API.
Actions: delete contact, add or modify tags to keep metadata synchronized.
DELETE /contacts/:contactId
Key fields: contactId
Unified data view: pull contact details, tasks, notes, and appointments into Callbell workflows without writing code.
Automated processes: trigger actions, updates, and reminders using visual builders and webhooks.
Faster onboarding: agents have richer context during conversations thanks to connected data.
This section defines API endpoints, authentication methods, data objects (contacts, tasks, notes), and common error handling practices to help you design robust integrations.
Application Programming Interface — a defined set of rules that enables software components to communicate with each other.
The process of granting access using tokens and scopes to perform actions on resources.
A specific URL path that exposes a resource or action in the API.
A callback mechanism that notifies your app in real time when certain events occur.
Trigger follow-up messages when a contact updates their profile or completes a task, keeping conversations timely.
Automatically reflect task status changes from Callbell into the Contacts API and vice versa.
Attach and surface notes in Callbell to provide agents with rich contact context during chats.
Obtain an API key or OAuth token with the contacts.readonly scope and securely store it for requests.
Use the exact endpoint URLs and HTTP methods listed in this guide, attaching the token in Authorization headers.
Run test requests, verify data flow, and implement error handling and retries before production use.
No special plan is required for basic connectivity, but access to specific endpoints may depend on your account permissions. Ensure your Callbell app is granted the proper scope (readonly) to read contact data. If you need write access, you may require additional permissions or a different plan.
The Contacts API uses token-based authentication. Use API keys or OAuth tokens with the contacts.readonly scope, and include the token in the Authorization header of every request. Rotate credentials regularly and store them securely.
Most endpoints are available when you have the right scope, but some operations may be gated by your account type or business permissions. Always verify endpoint availability in your dashboard and test in a staging environment.
From Callbell, configure the integration to pass an Authorization header with your API token on each request to the Contacts API. Use HTTPS to protect credentials, and prefer OAuth where supported for long-lived sessions.
Rate limits depend on your plan and the endpoint. Monitor response headers for quota information and implement retry logic with exponential backoff. If you anticipate higher volumes, contact support for guidance.
Yes, DELETE /contacts/:contactId allows removing a contact, and there are endpoints to delete or modify related notes or tasks. Exercise caution and consider soft-delete or archival strategies when needed.
Endpoint URLs are visible in your integration dashboard and in this guide. Copy the exact paths and methods (GET, POST, PUT, DELETE) when wiring Callbell to the Contacts API, and test changes in a safe environment.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
