Authenticate API calls using OAuth 2.0 tokens or API keys provided by the Contacts API. Store credentials securely and rotate keys regularly.
In Nimbata, configure your credentials to authorize calls to the Contacts API. Use OAuth for secure access and scope: contacts.readonly.
Endpoints include: 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 Nimbata, propagate the change to Contacts API to keep data current.
Actions: Upsert the contact in Contacts API (POST/PUT), update related tasks and notes as needed.
PUT /contacts/:contactId
contactId, email
Trigger: Updates to tasks or notes in Nimbata reflect in Contacts API.
Actions: Create/update tasks and notes in Contacts API; link to the relevant contactId.
POST /contacts/:contactId/tasks
contactId, taskId
Trigger: Schedule appointments in Nimbata and sync to Contacts API; apply tags when needed.
Actions: Create/update appointments and tags in Contacts API; ensure tag assignments map to contact.
POST /contacts/:contactId/appointments
contactId, appointmentId
Automated data flows reduce manual entry and errors.
Real-time sync keeps teams aligned across tools and platforms.
Scalable workflows with drag-and-drop automation and robust endpoints.
Key elements and processes: endpoints, authentication, data mapping, and error handling to ensure reliable integrations.
OAuth 2.0 is an authorization framework that lets apps obtain limited access tokens to call APIs on behalf of users, with scopes and expiry.
An API key is a simple token used to identify and authorize a client to an API, typically used for server-to-server integrations.
A webhook is a HTTP callback that lets an application notify another app when a specified event occurs.
A contact object represents a person in the system with fields like id, name, email, phone, and custom fields.
Capture form entries in Nimbata and push new contacts to Contacts API with minimal manual effort.
Automatically create tasks in Contacts API when a contact reaches a milestone or responds to a campaign.
Sync appointment data with calendar tools and send reminders via Nimbata and Contacts API.
Register Nimbata in the Contacts API developer console and generate client_id and client_secret.
Set allowed redirect URIs, grant types, and scope (e.g., contacts.readonly) for secure access.
Run test requests in a sandbox, validate data mappings, and then deploy to production.
OAuth 2.0 is the recommended method for securely accessing the Contacts API. It provides tokens with defined scopes that expire after a set period. To get started, register your app in the Contacts API developer portal and request a client_id and client_secret. Use these credentials to request access tokens and refresh tokens as needed. In Nimbata, configure these tokens in the integration settings and ensure scopes cover contacts.readonly for fetch operations and contacts.write for updates.
The available endpoints cover core contact management and related data. You can fetch a contact, their tasks, notes, and appointments, and you can create or update contacts and tasks, or add tags. When testing, use the sandbox environment to validate data mappings and response formats. For production, implement robust error handling and retries for transient failures.
Rate limits vary by endpoint and plan. Monitor response headers for remaining quota and implement exponential backoff on 429 responses. Use idempotent requests where possible (upsert operations) to prevent duplicate records, and ensure proper error messages are logged for troubleshooting.
Webhooks are recommended for real-time updates but optional in initial setups. Webhooks notify you of changes so you can trigger syncs automatically. If webhooks are unavailable, implement scheduled polling with sensible intervals to keep data reasonably fresh without overloading the API.
API credentials are found in the Contacts API developer console. Store them securely (e.g., in a secrets manager) and rotate regularly. Never expose client_secret in client-side code. Use server-side components to handle token requests and renewals, and restrict credential access to authorized personnel only.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
