Skip to main content

Google Calendar API Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Google Calendar API location.
google_cal_api.png

Google Calendar API

Create a Google Calendar API Destination​

  1. Click the + icon on the Nexset that will be sent to the Google Calendar API destination, and select the Send to Destination option from the menu.

  2. Select the Google Calendar API connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Google Calendar API organization, and click Next; or, create a new Google Calendar API credential for use in this flow.

  3. In Nexla, Google Calendar API destinations can be created using pre-built endpoint templates, which expedite destination setup for common Google Calendar API endpoints. Each template is designed specifically for the corresponding Google Calendar API endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Google Calendar API destinations can also be configured manually, allowing you to send data to Google Calendar API endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Google Calendar API endpoints. Each template is designed specifically for the corresponding Google Calendar API endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create Event

    Creates a new event on the specified Google Calendar. Use this endpoint to automate event creation from data in other systems — for example, creating calendar events from CRM data, booking records, or project management tools.

    • In the Calendar ID field, enter the identifier of the calendar where the event should be created. Common values include:

      • primary — the primary calendar of the authenticated user
      • A specific calendar email address (e.g., team@example.com) for shared or group calendars
      • A calendar ID obtained from the List Calendars data source endpoint
    • Ensure your Nexset data includes the required Google Calendar event fields. At minimum, each event record must include a summary (event title) and start and end datetime values. These map to the corresponding fields in the Google Calendar API events.insert request body.
    • Optional event fields that can be included in your data include description, location, attendees (as an array of email address objects), reminders, and conferenceData for video call links.

    Google Calendar requires all datetime values to be in RFC 3339 format (e.g., 2025-06-15T10:00:00-07:00) or in date-only format (e.g., 2025-06-15) for all-day events. Ensure your Nexset data transformations produce dates in the correct format before sending to this destination. For complete field definitions, refer to the Google Calendar API events.insert documentation.

    Update Event

    Updates an existing event on the specified Google Calendar. Use this endpoint to keep calendar events in sync with upstream data changes — for example, updating event details when a meeting time changes in a scheduling or CRM system.

    • In the Calendar ID field, enter the identifier of the calendar that contains the event to be updated. Use primary for the authenticated user's primary calendar, or enter a specific calendar ID.
    • In the Event ID field, enter the unique identifier of the event to update. This field is required. Event IDs can be obtained from the List Events or Get Event data source endpoints.
    • Include the event fields that should be updated in your Nexset data. Only the fields provided in the request body will be updated; other fields will remain unchanged (using the PATCH method behavior).

    Google Calendar supports both full replacement (PUT via events.update) and partial updates (PATCH via events.patch). Nexla's Update Event template uses the PATCH approach, meaning only the fields you include in the Nexset will be modified, preserving all other existing event data. For complete details, refer to the Google Calendar API events.patch documentation.

    Delete Event

    Deletes a specified event from a Google Calendar. Use this endpoint to automate event removal workflows — for example, canceling calendar events when corresponding records are deleted or canceled in an upstream system.

    • In the Calendar ID field, enter the identifier of the calendar that contains the event to be deleted. Use primary for the authenticated user's primary calendar, or enter a specific calendar ID.
    • In the Event ID field, enter the unique identifier of the event to delete. This field is required. Event IDs should be included in your Nexset data, typically sourced from a prior List Events or Get Event source.

    Deleting an event is a permanent action and cannot be undone via the API. If the event has attendees, Google Calendar will send cancellation notifications to attendees by default. To suppress cancellation notifications, the sendUpdates parameter can be set to none in a manual configuration. For additional details, refer to the Google Calendar API events.delete documentation.

Configure Manually​

Google Calendar API destinations can be manually configured to send data to any valid Google Calendar API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Google Calendar API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Google Calendar API from the Method pulldown menu. Common methods for Google Calendar API destination operations include:

    • POST: For creating new events, calendars, or other resources
    • PUT: For fully replacing an existing event with new data
    • PATCH: For partially updating an existing event (only the specified fields are changed)
    • DELETE: For removing an event or calendar resource

Data Format​

  1. Select the format in which the Nexset data will be sent to the Google Calendar API from the Content Format pulldown menu. Google Calendar API endpoints accept JSON format for request bodies. Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL​

  1. Enter the URL of the Google Calendar API endpoint to which you want to send the Nexset data in the URL field. The base URL for the Google Calendar API v3 is https://www.googleapis.com/calendar/v3. For update or delete operations, include the Calendar ID and Event ID as path parameters in the URL.

    Example endpoint URLs:

    • Create event: https://www.googleapis.com/calendar/v3/calendars/primary/events
    • Update or delete event: {'https://www.googleapis.com/calendar/v3/calendars/{calendarId}/events/{eventId}'}

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include the Authorization header — it is managed automatically by the Google Calendar API credential. The Content-Type: application/json header is also set automatically when JSON data format is selected.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Google Calendar API destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings.

Most Google Calendar API endpoints (such as events.insert and events.patch) accept a single event object per request and do not natively support bulk batch inserts in the standard REST API. When batching is enabled in Nexla, records are grouped and sent as individual calls within the configured batch size. For high-volume event creation, consider the Google Calendar API batch request capability — for complete details, refer to the Google Calendar API batching documentation.

Response Webhook​

Optional

Nexla can automatically send the response received from the Google Calendar API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Google Calendar API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Google Calendar API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Google Calendar API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to the configured Google Calendar API endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to the Google Calendar API endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.