Webhook event catalogue

Partner events

partner.church.created#

Account dataA partner created a customer church through the API.

Account facts about the church, its keys and connections: ids, names the church chose, scopes, roles and states. Secrets, tokens and key values are never included.

data.object.object is church.

Fields of data.object for partner.church.created
Field	Type	Description
`country` required	`string`	The ISO country code, empty when not set.
`counts` required	`object`	How much the church holds.
`members` required	`integer`	Team members.
`published_notes` required	`integer`	Published notes.
`teachings` required	`integer`	Teachings in the library.
`created_at` required	`string (date-time)`	When the church was created.
`deletion` required	`object \| null`	Set once deletion is scheduled.
`purge_after` required	`string (date-time)`	When the data is removed.
`requested_at` required	`string (date-time)`	When deletion was requested.
`stage` required	`enum: scheduled \| purged`	scheduled or purged.
`id` required	`string`	The church id.
`name` required	`string`	The church name.
`object` required	`enum: church`	Always church.
`plan` required	`object \| null`	The plan it is on, null before it has one.
`id` required	`string`	The plan id.
`key` required	`string`	The plan key.
`name` required	`string`	The plan name.
`object` required	`enum: plan`	Always plan.
`sandbox` required	`boolean`	True for a free sandbox church that expires.
`slug` required	`string`	The church web address.
`status` required	`enum: active \| suspended \| deletion_scheduled \| deleted`	Where the church stands.
`subscription_status` required	`string`	The subscription status, empty without a subscription.
`suspended_at` required	`string (date-time) \| null`	When it was suspended.

Example partner.church.created body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "country": "GB",
      "counts": {
        "members": 6,
        "published_notes": 96,
        "teachings": 148
      },
      "created_at": "2026-10-13T09:12:10Z",
      "deletion": {
        "purge_after": "2026-11-13T09:12:10Z",
        "requested_at": "2026-10-13T09:12:10Z",
        "stage": "scheduled"
      },
      "id": "org_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "name": "Grace Place",
      "object": "church",
      "plan": {
        "id": "plan_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "key": "church",
        "name": "Church",
        "object": "plan"
      },
      "sandbox": false,
      "slug": "grace-place",
      "status": "active",
      "subscription_status": "active",
      "suspended_at": "2026-10-13T09:12:10Z"
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "partner.church.created"
}

partner.church.updated#

Account dataA customer church changed its name or web address.

Account facts about the church, its keys and connections: ids, names the church chose, scopes, roles and states. Secrets, tokens and key values are never included.

data.object.object is church.

Fields of data.object for partner.church.updated
Field	Type	Description
`country` required	`string`	The ISO country code, empty when not set.
`counts` required	`object`	How much the church holds.
`members` required	`integer`	Team members.
`published_notes` required	`integer`	Published notes.
`teachings` required	`integer`	Teachings in the library.
`created_at` required	`string (date-time)`	When the church was created.
`deletion` required	`object \| null`	Set once deletion is scheduled.
`purge_after` required	`string (date-time)`	When the data is removed.
`requested_at` required	`string (date-time)`	When deletion was requested.
`stage` required	`enum: scheduled \| purged`	scheduled or purged.
`id` required	`string`	The church id.
`name` required	`string`	The church name.
`object` required	`enum: church`	Always church.
`plan` required	`object \| null`	The plan it is on, null before it has one.
`id` required	`string`	The plan id.
`key` required	`string`	The plan key.
`name` required	`string`	The plan name.
`object` required	`enum: plan`	Always plan.
`sandbox` required	`boolean`	True for a free sandbox church that expires.
`slug` required	`string`	The church web address.
`status` required	`enum: active \| suspended \| deletion_scheduled \| deleted`	Where the church stands.
`subscription_status` required	`string`	The subscription status, empty without a subscription.
`suspended_at` required	`string (date-time) \| null`	When it was suspended.

On updates, data.previous_attributes holds the earlier value of any of these that changed: name, slug, country.

Example partner.church.updated body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "country": "GB",
      "counts": {
        "members": 6,
        "published_notes": 96,
        "teachings": 148
      },
      "created_at": "2026-10-13T09:12:10Z",
      "deletion": {
        "purge_after": "2026-11-13T09:12:10Z",
        "requested_at": "2026-10-13T09:12:10Z",
        "stage": "scheduled"
      },
      "id": "org_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "name": "Grace Place",
      "object": "church",
      "plan": {
        "id": "plan_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "key": "church",
        "name": "Church",
        "object": "plan"
      },
      "sandbox": false,
      "slug": "grace-place",
      "status": "active",
      "subscription_status": "active",
      "suspended_at": "2026-10-13T09:12:10Z"
    },
    "previous_attributes": {
      "country": "Previous GB",
      "name": "Previous Grace Place",
      "slug": "Previous grace-place"
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "partner.church.updated"
}

partner.church.suspended#

Account dataA customer church was suspended or reinstated. status says which.

Account facts about the church, its keys and connections: ids, names the church chose, scopes, roles and states. Secrets, tokens and key values are never included.

data.object.object is church.

Fields of data.object for partner.church.suspended
Field	Type	Description
`country` required	`string`	The ISO country code, empty when not set.
`counts` required	`object`	How much the church holds.
`members` required	`integer`	Team members.
`published_notes` required	`integer`	Published notes.
`teachings` required	`integer`	Teachings in the library.
`created_at` required	`string (date-time)`	When the church was created.
`deletion` required	`object \| null`	Set once deletion is scheduled.
`purge_after` required	`string (date-time)`	When the data is removed.
`requested_at` required	`string (date-time)`	When deletion was requested.
`stage` required	`enum: scheduled \| purged`	scheduled or purged.
`id` required	`string`	The church id.
`name` required	`string`	The church name.
`object` required	`enum: church`	Always church.
`plan` required	`object \| null`	The plan it is on, null before it has one.
`id` required	`string`	The plan id.
`key` required	`string`	The plan key.
`name` required	`string`	The plan name.
`object` required	`enum: plan`	Always plan.
`sandbox` required	`boolean`	True for a free sandbox church that expires.
`slug` required	`string`	The church web address.
`status` required	`enum: active \| suspended \| deletion_scheduled \| deleted`	Where the church stands.
`subscription_status` required	`string`	The subscription status, empty without a subscription.
`suspended_at` required	`string (date-time) \| null`	When it was suspended.

On updates, data.previous_attributes holds the earlier value of any of these that changed: status, suspended_at.

Example partner.church.suspended body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "country": "GB",
      "counts": {
        "members": 6,
        "published_notes": 96,
        "teachings": 148
      },
      "created_at": "2026-10-13T09:12:10Z",
      "deletion": {
        "purge_after": "2026-11-13T09:12:10Z",
        "requested_at": "2026-10-13T09:12:10Z",
        "stage": "scheduled"
      },
      "id": "org_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "name": "Grace Place",
      "object": "church",
      "plan": {
        "id": "plan_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "key": "church",
        "name": "Church",
        "object": "plan"
      },
      "sandbox": false,
      "slug": "grace-place",
      "status": "active",
      "subscription_status": "active",
      "suspended_at": "2026-10-13T09:12:10Z"
    },
    "previous_attributes": {
      "status": "suspended",
      "suspended_at": "2026-10-12T09:12:10Z"
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "partner.church.suspended"
}

partner.church.deleted#

Account dataA customer church was scheduled for deletion or removed. deletion.stage is scheduled or purged.

Account facts about the church, its keys and connections: ids, names the church chose, scopes, roles and states. Secrets, tokens and key values are never included.

data.object.object is church.

Fields of data.object for partner.church.deleted
Field	Type	Description
`country` required	`string`	The ISO country code, empty when not set.
`counts` required	`object`	How much the church holds.
`members` required	`integer`	Team members.
`published_notes` required	`integer`	Published notes.
`teachings` required	`integer`	Teachings in the library.
`created_at` required	`string (date-time)`	When the church was created.
`deletion` required	`object \| null`	Set once deletion is scheduled.
`purge_after` required	`string (date-time)`	When the data is removed.
`requested_at` required	`string (date-time)`	When deletion was requested.
`stage` required	`enum: scheduled \| purged`	scheduled or purged.
`id` required	`string`	The church id.
`name` required	`string`	The church name.
`object` required	`enum: church`	Always church.
`plan` required	`object \| null`	The plan it is on, null before it has one.
`id` required	`string`	The plan id.
`key` required	`string`	The plan key.
`name` required	`string`	The plan name.
`object` required	`enum: plan`	Always plan.
`sandbox` required	`boolean`	True for a free sandbox church that expires.
`slug` required	`string`	The church web address.
`status` required	`enum: active \| suspended \| deletion_scheduled \| deleted`	Where the church stands.
`subscription_status` required	`string`	The subscription status, empty without a subscription.
`suspended_at` required	`string (date-time) \| null`	When it was suspended.

On updates, data.previous_attributes holds the earlier value of any of these that changed: status.

Example partner.church.deleted body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "country": "GB",
      "counts": {
        "members": 6,
        "published_notes": 96,
        "teachings": 148
      },
      "created_at": "2026-10-13T09:12:10Z",
      "deletion": {
        "purge_after": "2026-11-13T09:12:10Z",
        "requested_at": "2026-10-13T09:12:10Z",
        "stage": "scheduled"
      },
      "id": "org_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "name": "Grace Place",
      "object": "church",
      "plan": {
        "id": "plan_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "key": "church",
        "name": "Church",
        "object": "plan"
      },
      "sandbox": false,
      "slug": "grace-place",
      "status": "active",
      "subscription_status": "active",
      "suspended_at": "2026-10-13T09:12:10Z"
    },
    "previous_attributes": {
      "status": "suspended"
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "partner.church.deleted"
}

partner.church.plan_changed#

Account dataA customer church moved to a different plan.

Account facts about the church, its keys and connections: ids, names the church chose, scopes, roles and states. Secrets, tokens and key values are never included.

data.object.object is church.

Fields of data.object for partner.church.plan_changed
Field	Type	Description
`country` required	`string`	The ISO country code, empty when not set.
`counts` required	`object`	How much the church holds.
`members` required	`integer`	Team members.
`published_notes` required	`integer`	Published notes.
`teachings` required	`integer`	Teachings in the library.
`created_at` required	`string (date-time)`	When the church was created.
`deletion` required	`object \| null`	Set once deletion is scheduled.
`purge_after` required	`string (date-time)`	When the data is removed.
`requested_at` required	`string (date-time)`	When deletion was requested.
`stage` required	`enum: scheduled \| purged`	scheduled or purged.
`id` required	`string`	The church id.
`name` required	`string`	The church name.
`object` required	`enum: church`	Always church.
`plan` required	`object \| null`	The plan it is on, null before it has one.
`id` required	`string`	The plan id.
`key` required	`string`	The plan key.
`name` required	`string`	The plan name.
`object` required	`enum: plan`	Always plan.
`sandbox` required	`boolean`	True for a free sandbox church that expires.
`slug` required	`string`	The church web address.
`status` required	`enum: active \| suspended \| deletion_scheduled \| deleted`	Where the church stands.
`subscription_status` required	`string`	The subscription status, empty without a subscription.
`suspended_at` required	`string (date-time) \| null`	When it was suspended.

On updates, data.previous_attributes holds the earlier value of any of these that changed: plan.

Example partner.church.plan_changed body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "country": "GB",
      "counts": {
        "members": 6,
        "published_notes": 96,
        "teachings": 148
      },
      "created_at": "2026-10-13T09:12:10Z",
      "deletion": {
        "purge_after": "2026-11-13T09:12:10Z",
        "requested_at": "2026-10-13T09:12:10Z",
        "stage": "scheduled"
      },
      "id": "org_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "name": "Grace Place",
      "object": "church",
      "plan": {
        "id": "plan_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "key": "church",
        "name": "Church",
        "object": "plan"
      },
      "sandbox": false,
      "slug": "grace-place",
      "status": "active",
      "subscription_status": "active",
      "suspended_at": "2026-10-13T09:12:10Z"
    },
    "previous_attributes": {
      "plan": {
        "id": "plan_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "key": "church",
        "name": "Church",
        "object": "plan"
      }
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "partner.church.plan_changed"
}

partner.church.usage_threshold#

Account dataA customer church used up a share of one of its plan allowances.

Account facts about the church, its keys and connections: ids, names the church chose, scopes, roles and states. Secrets, tokens and key values are never included.

data.object.object is church.

Fields of data.object for partner.church.usage_threshold
Field	Type	Description
`country` required	`string`	The ISO country code, empty when not set.
`counts` required	`object`	How much the church holds.
`members` required	`integer`	Team members.
`published_notes` required	`integer`	Published notes.
`teachings` required	`integer`	Teachings in the library.
`created_at` required	`string (date-time)`	When the church was created.
`deletion` required	`object \| null`	Set once deletion is scheduled.
`purge_after` required	`string (date-time)`	When the data is removed.
`requested_at` required	`string (date-time)`	When deletion was requested.
`stage` required	`enum: scheduled \| purged`	scheduled or purged.
`id` required	`string`	The church id.
`name` required	`string`	The church name.
`object` required	`enum: church`	Always church.
`plan` required	`object \| null`	The plan it is on, null before it has one.
`id` required	`string`	The plan id.
`key` required	`string`	The plan key.
`name` required	`string`	The plan name.
`object` required	`enum: plan`	Always plan.
`sandbox` required	`boolean`	True for a free sandbox church that expires.
`slug` required	`string`	The church web address.
`status` required	`enum: active \| suspended \| deletion_scheduled \| deleted`	Where the church stands.
`subscription_status` required	`string`	The subscription status, empty without a subscription.
`suspended_at` required	`string (date-time) \| null`	When it was suspended.
`usage_threshold` required	`object`	The allowance that crossed this share.
`consumed` required	`integer`	What has been used this period.
`included` required	`integer`	What the plan includes, with credits.
`meter` required	`string`	The allowance, such as hours or asks.
`percent` required	`integer`	The share of the allowance used when this was sent: 80 or 100.
`period_start` required	`string (date-time)`	The first day of the billing period.

Example partner.church.usage_threshold body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "country": "GB",
      "counts": {
        "members": 6,
        "published_notes": 96,
        "teachings": 148
      },
      "created_at": "2026-10-13T09:12:10Z",
      "deletion": {
        "purge_after": "2026-11-13T09:12:10Z",
        "requested_at": "2026-10-13T09:12:10Z",
        "stage": "scheduled"
      },
      "id": "org_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "name": "Grace Place",
      "object": "church",
      "plan": {
        "id": "plan_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "key": "church",
        "name": "Church",
        "object": "plan"
      },
      "sandbox": false,
      "slug": "grace-place",
      "status": "active",
      "subscription_status": "active",
      "suspended_at": "2026-10-13T09:12:10Z",
      "usage_threshold": {
        "consumed": 32,
        "included": 40,
        "meter": "hours",
        "percent": 80,
        "period_start": "2026-10-13T09:12:10Z"
      }
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "partner.church.usage_threshold"
}

partner.key.issued#

Account dataA partner issued an API key for a customer church. The secret is never included.

Account facts about the church, its keys and connections: ids, names the church chose, scopes, roles and states. Secrets, tokens and key values are never included.

data.object.object is api_key.

Fields of data.object for partner.key.issued
Field	Type	Description
`church`	`object`	The customer church the key belongs to, on partner keys.
`id` required	`string`	The church id.
`name` required	`string`	The church name.
`object` required	`enum: church`	Always church.
`slug` required	`string`	The church web address.
`church_ids` required	`string[]`	Customer churches a partner key may act for; empty means all.
`created_at` required	`string (date-time)`	When it was created.
`created_by` required	`object \| null`	The team member who created it.
`id` required	`string`	The team member id.
`object` required	`enum: user`	Always user.
`expires_at` required	`string (date-time) \| null`	When the key stops working.
`id` required	`string`	The API key id.
`last4` required	`string`	The last four characters of the key.
`mode` required	`enum: live \| test`	live or test.
`name` required	`string`	The label given to the key.
`object` required	`enum: api_key`	Always api_key.
`partner` required	`boolean`	True for a partner key.
`prefix` required	`string`	The visible start of the key.
`rate_limit_per_minute` required	`integer \| null`	The per-minute limit, null for the plan default.
`revoked_at` required	`string (date-time) \| null`	When it was revoked.
`scopes` required	`string[]`	The permissions it was given.

Example partner.key.issued body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "church": {
        "id": "org_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "name": "Grace Place",
        "object": "church",
        "slug": "grace-place"
      },
      "church_ids": [],
      "created_at": "2026-10-13T09:12:10Z",
      "created_by": {
        "id": "usr_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "object": "user"
      },
      "expires_at": "2026-11-13T09:12:10Z",
      "id": "key_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "last4": "a91c",
      "mode": "live",
      "name": "CRM sync",
      "object": "api_key",
      "partner": false,
      "prefix": "folio_live_3f9d",
      "rate_limit_per_minute": 600,
      "revoked_at": "2026-10-13T09:12:10Z",
      "scopes": [
        "teachings:read",
        "notes:read"
      ]
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "partner.key.issued"
}

Verified against API version 0.0.0-dev. Generated from the live OpenAPI document.