Skip to content

EventConnection (Calendar)

A connection between a Calendar event and a record in another product

A connection between a Calendar event and a record in another product

Property Value
Product Calendar (pco.calendar, API version 2026-06-22)
Resource type EventConnection
TypeScript Calendar.EventConnection, attributes Calendar.EventConnectionAttributes, schema Calendar.EventConnectionSchema
Planning Center path /calendar/v2/events/{event_id}/event_connections
Planning Center docs EventConnection

How to reach it

Client path Returns Filters Create
pco.calendar.events.id(eventId).event_connections Collection Yes

From a collection, .id(eventConnectionId) addresses one EventConnection: pco.calendar.events.id(eventId).event_connections.id(eventConnectionId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Calendar.EventConnectionAttributes. Every resource also has id and type ('EventConnection') next to its attributes.

Name Type Description
connected_to_id string | null Unique identifier for the connected record
connected_to_name string | null Name of the record that the event is connected to
connected_to_type string | null Currently we support signup, group, event, and service_type
connected_to_url string | null A link to the connected record
product_name string | null Currently we support registrations, groups, check-ins, and services
promoted boolean | null See details.

Attribute details

Whether this connection is promoted for display (only applies to Groups connections)

Only available when requested with the ?fields param

Relationships and includes

Planning Center documents no includes for this resource.

Relationship Type To Includable
event To one Event No

Querying

Where

where(field, value) for equality; where(field, op, value) with the operators listed.

Field Value type Operators
connected_to_id string Equality only
product_name string Equality only
promoted boolean Equality only

No documented order fields.

Edges

This resource has no documented edges.

Writing

Property Value
Create Yes, create() on event_connections on Event
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as Calendar.EventConnectionSchema['create'].

Attribute Type
connected_to_id string | null
connected_to_name string | null
connected_to_type string | null
product_name string | null
promoted boolean | null

Update attributes

Typed as Calendar.EventConnectionSchema['update'].

Attribute Type
connected_to_id string | null
connected_to_name string | null
connected_to_type string | null
product_name string | null
promoted boolean | null

See Writing data.

Example

import type { Calendar } from '@mackenly/planningcenterkit';

const eventId = '1'; // Event id

const page = await pco.calendar.events.id(eventId).event_connections.perPage(25).list();
const items: Calendar.EventConnection[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close