To begin, generate a secure API key for the Contacts API with the scope set to read-only access (contacts.readonly). This keeps your data safe while enabling needed reads from Tidbyt.
In Tidbyt, create an API key or connect via OAuth as required, then select the Contacts API scope (contacts.readonly). Store credentials securely and test the connection.
– 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 – contacts.write – 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 created or updated in the Contacts API.
Actions: push a Tidbyt card with contact highlights, or trigger alerts to teams.
GET /contacts/:contactId
Key fields: contactId, name, email, phone, status
Trigger: a new or updated task for a contact.
Actions: display task status on Tidbyt; update badges.
POST /contacts/:contactId/tasks
Key fields: contactId, taskId, title, status, dueDate
Trigger: a new or updated note for a contact.
Actions: post note snippet to Tidbyt, or append to display.
GET /contacts/:contactId/notes
Key fields: contactId, id, note, createdAt
No-code setup lets non-developers automate data flows using a visual builder.
Fast time-to-value with quick connectors and ready-made triggers.
Centralized visibility across Tidbyt displays without a line of code.
A concise glossary explaining APIs, endpoints, authentication, and how elements connect in this Tidbyt–Contacts integration.
Application Programming Interface: a set of rules and endpoints that let apps request and receive data.
A secure authorization framework that lets apps access data on behalf of a user.
A specific URL path in an API that performs a function, such as retrieving a contact.
A callback URL that gets invoked when a defined event occurs.
Show real-time contact changes, such as name changes or status updates, on a Tidbyt board.
Post a daily digest of new or modified contacts to Tidbyt.
Push upcoming task reminders from Contacts API to Tidbyt for team visibility.
Generate an API key with the desired scope (contacts.readonly) in the Contacts API settings and securely store it.
Authorize Tidbyt to access Contacts data and select the triggers and actions you want.
Run tests to verify data flow and then enable the workflow in production.
At minimum, you need read access to the Contacts API with the scope contacts.readonly to connect Tidbyt and view contact data. This keeps your data secure while enabling necessary reads from Tidbyt. If you later need to modify contacts from Tidbyt, you would need broader permissions such as contacts.write and appropriate role-based access. Always align permissions with your actual use case and security requirements. If you require write access, request the higher scope and ensure you audit credential usage and rotate keys regularly to maintain security.
Yes. You can map fields like name, status, phone, and note content to Tidbyt displays. Use the Zapier app connector to define which fields appear on the Tidbyt card and how they should be formatted. You can also apply display templates and filters so only relevant contacts or tasks show up on your Tidbyt boards.
No coding is required when using the Zapier App Connector. The visual workflow builder handles triggers, actions, and mappings between the Contacts API and Tidbyt. If you need custom logic beyond the built-in options, you can add optional webhook steps or additional actions in your workflow, but it is not required for a basic connection.
The Contacts API exposes endpoints for retrieving contacts, their tasks, notes, and related data, such as GET /contacts/:contactId, GET /contacts/:contactId/tasks, GET /contacts/:contactId/notes, and more. The exact endpoints you use depend on your goals (e.g., displaying contact info, task status, or notes on Tidbyt). Refer to the endpoint list in this guide for a concise set of core calls.
Security is maintained through API keys or OAuth with scoped permissions and HTTPS transport. Rotate credentials regularly, restrict to the minimum necessary scopes, and monitor access logs. Pair credentials with strong access controls and periodic reviews to minimize risk.
Yes. You can apply filters in Zapier or leverage endpoint-specific query parameters (where supported) to limit which contacts or tasks are synced to Tidbyt. This helps ensure Tidbyt only displays the most relevant data and reduces noise on your displays.
If syncs fail, check your credentials, permissions, and endpoint availability. Review error messages in your Zapier task history, verify that the correct endpoints are being called, and ensure the integration is active. Test the connection after updates and consult the API documentation or support resources if issues persist.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
