API
⌘K
My Developer Account

Event

Example Request 

curl https://api.planningcenteronline.com/webhooks/v2/webhook_subscriptions/{webhook_subscription_id}/events

View in API Explorer →

Example Object 

{
  "type": "Event",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "payload": "string",
    "status": "value",
    "updated_at": "2000-01-01T12:00:00Z",
    "uuid": "string"
  },
  "relationships": {
    "subscription": {
      "data": {
        "type": "Subscription",
        "id": "1"
      }
    },
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
created_at date_time
id primary_key
payload string

A string encoded JSON object. E.G. "{\"data\":{...}}"
status string

Possible values: pending, delivered, failed, skipped, duplicated, ignored_failed, ignored_skipped, or ignored_duplicated
updated_at date_time
uuid string

Relationships

Name Type Association Type Note
subscription Subscription to_one
person Person to_one

Order By

Parameter Value Type Description
order created_at string

prefix with a hyphen (-created_at) to reverse the order

Query By

Name Parameter Type Description Example
status where[status] string

Query on a specific status

Possible values: pending, delivered, failed, skipped, duplicated, ignored_failed, ignored_skipped, or ignored_duplicated

 ?where[status]=value
uuid where[uuid] string

Query on a specific uuid

 ?where[uuid]=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/{webhook_subscription_id}/events

Reading

HTTP Method Endpoint
GET /webhooks/v2/webhook_subscriptions/{webhook_subscription_id}/events/{id}

Actions

HTTP Method Endpoint Description
POST https://api.planningcenteronline.com/webhooks/v2/webhook_subscriptions/{webhook_subscription_id}/events/{event_id}/ignore
POST https://api.planningcenteronline.com/webhooks/v2/webhook_subscriptions/{webhook_subscription_id}/events/{event_id}/redeliver

Associations

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

Belongs To

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