An event supported by webhooks
| Property | Value |
|---|---|
| Product | Webhooks (pco.webhooks, API version 2022-10-20) |
| Resource type | AvailableEvent |
| TypeScript | Webhooks.AvailableEvent, attributes Webhooks.AvailableEventAttributes, schema Webhooks.AvailableEventSchema |
| Planning Center path | /webhooks/v2/available_events |
| Planning Center docs | AvailableEvent |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.webhooks.available_events |
Collection | No |
From a collection, .id(availableEventId) addresses one AvailableEvent: pco.webhooks.available_events.id(availableEventId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Webhooks.AvailableEventAttributes. Every resource also has id and type ('AvailableEvent') next to its attributes.
| Name | Type | Description |
|---|---|---|
action |
string | null |
|
app |
string | null |
|
name |
string | null |
|
resource |
string | null |
|
type |
string | null |
|
version |
string | null |
Querying
No documented where fields.
No documented order fields.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Webhooks } from '@mackenly/planningcenterkit';
const page = await pco.webhooks.available_events.perPage(25).list();
const items: Webhooks.AvailableEvent[] = page.data;