TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node allows you to create a new calendar channel within the connected calendar system. A calendar channel typically represents a subscription or connection to a calendar feed, enabling synchronization of events and metadata between the external calendar provider and your workflow.

Common scenarios for this node include:

  • Automating the creation of calendar channels to monitor specific calendars.
  • Setting up synchronization parameters for event imports and updates.
  • Managing visibility and sync status of calendar data in integrated applications.

For example, you might use this node to programmatically add a new calendar channel that automatically syncs events from a user's Google Calendar into your CRM system, with custom sync policies and visibility settings.

Properties

Name Meaning
Depth Determines how much nested related object information is included in the response: 0 (primary object only), 1 (primary + directly related objects), 2 (primary + related objects + their related objects).
Handle The unique identifier or handle for the calendar channel being created.
Sync Status The current synchronization status of the calendar channel. Options: ONGOING, NOT SYNCED, ACTIVE, FAILED INSUFFICIENT PERMISSIONS, FAILED UNKNOWN.
Sync Stage The current stage of synchronization. Options include various fetch and import stages such as FULL CALENDAR EVENT LIST FETCH PENDING, CALENDAR EVENTS IMPORT ONGOING, FAILED, etc.
Visibility Controls the visibility level of the calendar channel. Options: METADATA, SHARE EVERYTHING.
Is Contact Auto Creation Enabled Boolean flag indicating whether automatic creation of contact records for event participants/organizers is enabled.
Contact Auto Creation Policy Defines the policy for auto-creating contacts based on event participation. Options: AS PARTICIPANT AND ORGANIZER, AS PARTICIPANT, AS ORGANIZER, NONE.
Is Sync Enabled Boolean flag indicating if synchronization is enabled for this calendar channel.
Sync Cursor A string token used to track the position/state for syncing events from the calendar provider.
Synced At Timestamp string representing the last time the calendar channel was successfully synced.
Sync Stage Started At Timestamp string indicating when the current sync stage started.
Throttle Failure Count Number representing how many times sync attempts have failed due to throttling limits.
Connected Account Id Identifier for the connected account associated with this calendar channel.

Output

The node outputs JSON data representing the newly created calendar channel object. This includes all properties sent during creation along with any additional metadata returned by the API, such as unique IDs, timestamps, and nested related objects depending on the Depth parameter.

If binary data were involved (not indicated here), it would typically represent attachments or media related to calendar events, but this node focuses on JSON metadata about calendar channels.

Dependencies

  • Requires an active connection to the Twenty API service via an API key credential.
  • The node expects the base URL and authentication credentials to be configured in n8n credentials.
  • No other external dependencies are indicated.

Troubleshooting

  • Invalid or missing required fields: Ensure mandatory properties like handle and connectedAccountId are provided and correctly formatted.
  • Permission errors: If the sync status shows "FAILED INSUFFICIENT PERMISSIONS," verify that the connected account has adequate permissions to create calendar channels.
  • Throttle failures: Repeated sync failures due to throttling may require adjusting sync frequency or handling retry logic externally.
  • Incorrect enum values: Use only the specified options for properties like syncStatus, syncStage, visibility, and contactAutoCreationPolicy.
  • API connectivity issues: Confirm that the API key and domain are correctly set in credentials and that the network allows outbound requests to the API endpoint.

Links and References

Discussion