TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node operation creates a new association between a calendar channel and an event within that channel. It is useful when you want to link or register an event to a specific calendar channel programmatically. For example, if you manage multiple calendars and events in an application, this node helps automate the process of associating events with their respective calendar channels, ensuring proper organization and retrieval.

Practical scenarios include:

  • Automatically linking newly created events to a designated calendar channel.
  • Synchronizing external event data by associating them with internal calendar channels.
  • Managing recurring events by associating them with calendar channels for tracking and updates.

Properties

Name Meaning
Depth Determines how much related nested information to include in the response:
- 0: Only the primary object's information.
- 1: Primary object plus directly related objects.
- 2: Primary object, its related objects, and their related objects.
Recurring Event External Id The external identifier for a recurring event, used to associate the event as part of a recurring series.
Calendar Event Id The unique identifier of the calendar event to associate.
Calendar Channel Id The unique identifier of the calendar channel where the event will be associated.
Event External Id An external identifier for the event, useful for referencing events from outside systems.

Output

The output JSON contains the details of the newly created calendar channel event association. Depending on the Depth property, it may include nested related objects up to two levels deep. This typically includes identifiers and metadata about the association, the linked calendar event, and the calendar channel.

If binary data were involved (not indicated here), it would represent attachments or media related to the event association, but this node focuses on JSON data representing the association itself.

Dependencies

  • Requires an API key credential for authenticating requests to the underlying Twenty API service.
  • The node uses the Twenty API base URL configured via credentials.
  • No additional environment variables are explicitly required beyond standard API authentication setup.

Troubleshooting

  • Missing or invalid IDs: Ensure that Calendar Event Id and Calendar Channel Id are valid and exist in the system; otherwise, the API will reject the association creation.
  • Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Invalid depth value: Use only allowed values (0, 1, or 2) for the Depth property to avoid unexpected responses or errors.
  • Network issues: Check connectivity to the API endpoint and ensure no firewall or proxy blocks the request.

Common error messages might include:

  • Unauthorized access due to invalid credentials — resolve by updating the API key.
  • Resource not found if IDs do not correspond to existing entities — verify IDs before running.
  • Validation errors if required properties are missing — ensure all mandatory fields are provided.

Links and References

Discussion