WebhookSubscription - Webhooks API

Example Request

curl https://api.planningcenteronline.com/webhooks/v2/webhook_subscriptions

View in API Explorer →

Example Object

{
  "type": "WebhookSubscription",
  "id": "1",
  "attributes": {
    "active": true,
    "application_id": "string",
    "authenticity_secret": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "name": "string",
    "updated_at": "2000-01-01T12:00:00Z",
    "url": "string"
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`active`	`boolean`
`application_id`	`string`
`authenticity_secret`	`string`	Every delivery will include a header `X-PCO-Webhooks-Authenticity`. This header will be the `HMAC-SHA256` value of this the `authenticity_secret` used as the key, and the message as the webhook body. `hmac_sha256(authenticity_secret, webhook_body)`
`created_at`	`date_time`
`id`	`primary_key`
`name`	`string`
`updated_at`	`date_time`
`url`	`string`

Query By

Name	Parameter	Type	Description	Example
application_id	`where[application_id]`	string	Query on a specific application_id	`?where[application_id]=string`

Pagination

Name	Parameter	Type	Description
per_page	per_page	integer	how many records to return per page (min=1, max=100, default=25)
offset	offset	integer	get results from given offset

Endpoints

Listing

HTTP Method	Endpoint
GET	`/webhooks/v2/webhook_subscriptions`

Reading

HTTP Method	Endpoint
GET	`/webhooks/v2/webhook_subscriptions/{id}`

Creating

HTTP Method	Endpoint	Assignable Attributes
POST	`/webhooks/v2/webhook_subscriptions`	name url active

Updating

HTTP Method	Endpoint	Assignable Attributes
PATCH	`/webhooks/v2/webhook_subscriptions/{id}`	active

Deleting

HTTP Method	Endpoint
DELETE	`/webhooks/v2/webhook_subscriptions/{id}`

Actions

HTTP Method	Endpoint	Description
POST	`https://api.planningcenteronline.com/webhooks/v2/webhook_subscriptions/{webhook_subscription_id}/rotate_secret`

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/webhooks/v2/webhook_subscriptions/{webhook_subscription_id}/events`	Event

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/webhooks/v2/webhook_subscriptions`	Organization