| Property | Value |
|---|---|
| Product | Webhooks (pco.webhooks, API version 2022-10-20) |
| Resource type | Event |
| TypeScript | Webhooks.Event, attributes Webhooks.EventAttributes, schema Webhooks.EventSchema |
| Planning Center path | /webhooks/v2/webhook_subscriptions/{webhook_subscription_id}/events |
| Planning Center docs | Event |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.webhooks.webhook_subscriptions.id(webhookSubscriptionId).events |
Collection | No |
From a collection, .id(eventId) addresses one Event: pco.webhooks.webhook_subscriptions.id(webhookSubscriptionId).events.id(eventId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Webhooks.EventAttributes. Every resource also has id and type ('Event') next to its attributes.
| Name | Type | Description |
|---|---|---|
created_at |
string | null |
|
payload |
string | null |
A string encoded JSON object. E.G. "{\"data\":{...}}" |
status |
string | null |
Possible values: pending, delivered, failed, skipped, duplicated, ignored_failed, ignored_skipped, or ignored_duplicated |
updated_at |
string | null |
|
uuid |
string | null |
Relationships and includes
Planning Center documents no includes for this resource.
| Relationship | Type | To | Includable |
|---|---|---|---|
person |
To one | Person |
No |
subscription |
To one | Subscription |
No |
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
status |
string |
Equality only |
uuid |
string |
Equality only |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: created_at.
Edges
Follow these from one Event, ref = pco.webhooks.webhook_subscriptions.id(webhookSubscriptionId).events.id(eventId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.deliveries |
Delivery | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Actions
Run with ref.action(name, body?). Bodies are untyped: see Planning Center’s docs for each action.
| Action | Path | Description |
|---|---|---|
ignore |
POST /webhooks/v2/webhook_subscriptions/{webhook_subscription_id}/events/{event_id}/ignore |
|
redeliver |
POST /webhooks/v2/webhook_subscriptions/{webhook_subscription_id}/events/{event_id}/redeliver |
Example
import type { Webhooks } from '@mackenly/planningcenterkit';
const webhookSubscriptionId = '1'; // WebhookSubscription id
const page = await pco.webhooks.webhook_subscriptions.id(webhookSubscriptionId).events.order('created_at').perPage(25).list();
const items: Webhooks.Event[] = page.data;