Calendar Sync API Requirements

This document outlines the required API endpoints and data structures for integrating your CRM with BrightSync's Calendar Synchronization features.

BrightSync will interact with the following endpoints on your CRM connector to create, retrieve, and update calendar event objects.

Calendar Event Object

BrightSync requires a CRM object (e.g., a Meeting or Calendar Event object) that can store the following or similar fields to facilitate two-way synchronization.

API Field	Data Type	Description
id	String	The unique identifier for the event in your CRM. Required for two-way sync.
subject	String	The title of the calendar event.
description	String	The description or agenda of the meeting.
startTime	DateTime	The start date and time of the event.
endTime	DateTime	The end date and time of the event.
location	String	The physical or virtual meeting location.
allDay	boolean	Flag indicating if the event spans the entire day.
private	boolean	Flag indicating if the event details should be hidden.
attendees	List<Attendee>	A list of meeting participants (see structure below).
parentId	Long	The ID of the parent meeting, for calendars that create child events for each attendee.
relatedTo	RealtedTo	The CRM object(s) (Contact, Account, Opportunity) this meeting is linked/logged against.
lastModifiedAt	DateTime	Timestamp of the last modification. Crucial for delta sync operations.

Attendee Object Structure

The Attendee object within the event payload must support the following structure:

API Field	Data Type	Description
userId	String	The CRM user ID if the attendee is an internal system user.
emailAddress	String	The email address of the attendee.
contactId	Long	The ID of the associated Contact record in your CRM (if applicable).
status	String	The RSVP status of the attendee (e.g., "Accepted," "Declined," "Tentative").

Calendar Sync API Endpoints

Assuming one primary calendar. Additinal Calendar List API may be required if CRM supports multiple user calendars.

Read/Retrieve (Delta Sync) Endpoints

Operation	Requirement	Method	Endpoint Example
Retrieve All in Interval	Endpoint to receive all events within a specified time range.	GET	/api/v1/events?startAt={timestamp}&endAt={timestamp}
Delta Sync (Modified/Changed)	Endpoint to retrieve events modified since a given timestamp (lastModifiedAt).	GET	/api/v1/events?since={timestamp}
Deleted Events Retrieval	Method to retrieve events that have been deleted (either via a showDeleted=true flag or a separate endpoint).	GET	/api/v1/deletedEvents?since={timestamp}
Load Event by ID	Standard endpoint to load a single event by its unique CRM ID.	GET	/api/v1/events/{id}

Write (CRUD) Endpoints

Operation	Requirement	Method	Endpoint Example
Create New Event	Endpoint for creating a new calendar event in the CRM.	POST	/api/v1/events
Update Existing Event	Endpoint for updating an existing calendar event based on its CRM ID.	PATCH or PUT	/api/v1/events/{id}
Delete Event	Endpoint for deleting a calendar event based on its CRM ID.