Skip to content

Delivery (Webhooks)

The Delivery resource in Planning Center Webhooks: how to reach it, its attributes, and what you can query and write.

Property Value
Product Webhooks (pco.webhooks, API version 2022-10-20)
Resource type Delivery
TypeScript Webhooks.Delivery, attributes Webhooks.DeliveryAttributes, schema Webhooks.DeliverySchema
Planning Center path /webhooks/v2/webhook_subscriptions/{webhook_subscription_id}/events/{event_id}/deliveries
Planning Center docs Delivery

How to reach it

Client path Returns Filters Create
pco.webhooks.webhook_subscriptions.id(webhookSubscriptionId).events.id(eventId).deliveries Collection No

From a collection, .id(deliveryId) addresses one Delivery: pco.webhooks.webhook_subscriptions.id(webhookSubscriptionId).events.id(eventId).deliveries.id(deliveryId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Webhooks.DeliveryAttributes. Every resource also has id and type ('Delivery') next to its attributes.

Name Type Description
created_at string | null
object_url string | null
request_body string | null
request_headers string | null
response_body string | null
response_headers string | null
status number | null
timing number | null
updated_at string | null

Relationships and includes

Planning Center documents no includes for this resource.

Relationship Type To Includable
event To one Event No

Querying

No documented where fields.

Order

order(...) accepts these fields, ascending, or descending with a - prefix: created_at.

Edges

This resource has no documented edges.

Writing

Property Value
Create No
Update No
Delete No

Example

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

const webhookSubscriptionId = '1'; // WebhookSubscription id
const eventId = '1'; // Event id

const page = await pco.webhooks.webhook_subscriptions.id(webhookSubscriptionId).events.id(eventId).deliveries.order('created_at').perPage(25).list();
const items: Webhooks.Delivery[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close