Webhook event catalogue

Folio support access events

support.access_granted#

Account dataAn owner let Folio support into the church for a limited time. The reason is not 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 support_grant.

Fields of data.object for support.access_granted
Field	Type	Description
`created_at` required	`string (date-time)`	When it was granted.
`entry_number`	`integer`	On entry events, how many times the grant has been used including this one.
`expires_at` required	`string (date-time)`	When the access ends on its own.
`first_entered_at` required	`string (date-time) \| null`	When support first used it.
`granted_by` required	`object \| null`	The owner who granted it.
`id` required	`string`	The team member id.
`object` required	`enum: user`	Always user.
`id` required	`string`	The grant id.
`include_ask` required	`boolean`	True when the grant also lets Folio support read Ask conversations.
`object` required	`enum: support_grant`	Always support_grant.
`revoked_at` required	`string (date-time) \| null`	When it was revoked.
`scope` required	`enum: read \| edit`	read or edit.
`status` required	`enum: active \| revoked \| expired`	Where the grant stands.

Example support.access_granted body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "created_at": "2026-10-13T09:12:10Z",
      "entry_number": 1,
      "expires_at": "2026-10-13T09:12:10Z",
      "first_entered_at": "2026-10-13T09:12:10Z",
      "granted_by": {
        "id": "usr_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "object": "user"
      },
      "id": "sup_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "include_ask": false,
      "object": "support_grant",
      "revoked_at": "2026-10-13T09:12:10Z",
      "scope": "read",
      "status": "active"
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "support.access_granted"
}

support.access_entered#

Account dataA Folio support person entered the church under a grant. Sent on every entry. entry_number counts them.

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 support_grant.

Fields of data.object for support.access_entered
Field	Type	Description
`created_at` required	`string (date-time)`	When it was granted.
`entry_number`	`integer`	On entry events, how many times the grant has been used including this one.
`expires_at` required	`string (date-time)`	When the access ends on its own.
`first_entered_at` required	`string (date-time) \| null`	When support first used it.
`granted_by` required	`object \| null`	The owner who granted it.
`id` required	`string`	The team member id.
`object` required	`enum: user`	Always user.
`id` required	`string`	The grant id.
`include_ask` required	`boolean`	True when the grant also lets Folio support read Ask conversations.
`object` required	`enum: support_grant`	Always support_grant.
`revoked_at` required	`string (date-time) \| null`	When it was revoked.
`scope` required	`enum: read \| edit`	read or edit.
`status` required	`enum: active \| revoked \| expired`	Where the grant stands.

Example support.access_entered body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "created_at": "2026-10-13T09:12:10Z",
      "entry_number": 1,
      "expires_at": "2026-10-13T09:12:10Z",
      "first_entered_at": "2026-10-13T09:12:10Z",
      "granted_by": {
        "id": "usr_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "object": "user"
      },
      "id": "sup_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "include_ask": false,
      "object": "support_grant",
      "revoked_at": "2026-10-13T09:12:10Z",
      "scope": "read",
      "status": "active"
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "support.access_entered"
}

support.access_revoked#

Account dataSupport access ended because an owner revoked it or it reached its expiry. 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 support_grant.

Fields of data.object for support.access_revoked
Field	Type	Description
`created_at` required	`string (date-time)`	When it was granted.
`entry_number`	`integer`	On entry events, how many times the grant has been used including this one.
`expires_at` required	`string (date-time)`	When the access ends on its own.
`first_entered_at` required	`string (date-time) \| null`	When support first used it.
`granted_by` required	`object \| null`	The owner who granted it.
`id` required	`string`	The team member id.
`object` required	`enum: user`	Always user.
`id` required	`string`	The grant id.
`include_ask` required	`boolean`	True when the grant also lets Folio support read Ask conversations.
`object` required	`enum: support_grant`	Always support_grant.
`revoked_at` required	`string (date-time) \| null`	When it was revoked.
`scope` required	`enum: read \| edit`	read or edit.
`status` required	`enum: active \| revoked \| expired`	Where the grant stands.

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

Example support.access_revoked body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "created_at": "2026-10-13T09:12:10Z",
      "entry_number": 1,
      "expires_at": "2026-10-13T09:12:10Z",
      "first_entered_at": "2026-10-13T09:12:10Z",
      "granted_by": {
        "id": "usr_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "object": "user"
      },
      "id": "sup_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "include_ask": false,
      "object": "support_grant",
      "revoked_at": "2026-10-13T09:12:10Z",
      "scope": "read",
      "status": "active"
    },
    "previous_attributes": {
      "status": "revoked"
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "support.access_revoked"
}

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