Access is controlled via a scoped API key or OAuth2 token. Ensure the scope contacts.readonly is granted for read only access to contact data.
In Vitally, create an integration, generate credentials, and securely store the token. Include the token in your API requests as a bearer token.
Endpoints and actions: 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, permissions: 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 updated in Vitally, fetch the latest from the Contacts API
Actions: GET /contacts/:contactId and map fields to the Vitally contact profile
GET /contacts/:contactId
Key fields: id, name, email, phone, tags
Trigger: new or updated tasks and notes tied to a contact
Actions: pull /contacts/:contactId/tasks and /contacts/:contactId/notes
GET /contacts/:contactId/tasks, GET /contacts/:contactId/notes
Key fields: taskId, noteId, subject, dueDate, status
Trigger: task status changes to completed in Vitally
PUT /contacts/:contactId/tasks/:taskId/completed
Key fields: taskId, completed, completedAt
Fast setup with ready to use endpoints and example triggers
Automated data syncing reduces manual work and avoids stale data
No code maintenance saves time and scales across teams
This glossary explains endpoints, triggers, actions and key fields you will work with
A specific URL path in an API used to perform a defined action
The method to verify identity and grant access to API resources
An event that starts an automated workflow or data sync
An operation performed after a trigger to update data or perform tasks
When a contact is updated in Vitally, fetch enriched data from the Contacts API and attach to the profile
Create tasks in Vitally based on important contact events from the API
Sync notes from Contacts API to Vitally to preserve conversation history
Obtain an access token with scope contacts.readonly and authorize the Vitally integration
Choose endpoints to sync contacts tasks and notes and set mapping rules
Run end to end tests verify data consistency and enable alerts
You will need an API key or OAuth token with the right scope. Ensure your app has read permission for contacts. Store credentials securely and rotate them regularly. Use the Authorization header to pass the token in each request.
The primary endpoints are GET /contacts/:contactId GET /contacts/:contactId/tasks GET /contacts/:contactId/notes and GET /contacts/; additional endpoints fetch tags and business associations. Map fields carefully to Vitally and validate data after each sync.
Yes, you can write updates back if you have the contacts.write permission and the corresponding endpoints like POST and PUT. Implement conflict handling and test changes in a staging environment first.
Use an OAuth2 token or an API key with proper scopes. Include Authorization: Bearer
No code is required when using ready made connectors and the Vitally and Contacts API integration. You can configure endpoints, mapping rules, and triggers through the UI without writing code.
Data changes sync according to the triggers you set. When a source system updates a contact, Vitally receives the new data on the next poll or webhook event and updates fields accordingly.
Rate limits apply to API requests. Plan for bursts, implement retry logic with exponential backoff, and spread requests over time to avoid hitting limits.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
