Pular para o conteúdo

Payload reference

The first resource in included is the affected subject snapshot. Attribute names are kebab-case except for keys inside selected embedded objects such as phones, address, and settings, whose documented source keys are preserved.

Undefined fields are omitted, explicit null values are preserved, strings are trimmed, dates are serialized as ISO 8601 values, and object IDs are lowercase 24-character strings. To-many relationship IDs are deduplicated and sorted.

Used by person.created and person.updated.

created-at, updated-at, name, full-name, nickname, email, phones,
sex, marital-status, spouse, wedding-date, birthdate, anniversary,
deathdate, is-deceased, citizenship, place-of-birth, blood-type,
blood-donor, profession, age, father, mother, address, is-active,
activated-at, deactivated-at, is-anonymized, anonymized-at, is-member,
self-declared-member, is-baptized, admission, admission-date,
termination-date, decision-for-christ-at, avatar-hash, avatar-source

membership can contain:

baptism-date, previous-church, conversion-year, baptism-church

Each item in phones is limited to countryCode, number, and label. address is limited to:

streetType, street, number, complement, neighborhood, city, state,
country, postalCode, location.lat, location.lng, location.locationType
Name Cardinality Resource type
church-campus To one church-campuses
baptism-church-campus To one church-campuses

Passwords, password-reset data, confirmation tokens, identity documents, arbitrary custom data, administrative roles, payment-provider identifiers, legal-acceptance details, and internal activity caches are not included.

The same groups snapshot is used by cell and coaching-group events. Inspect group-type to distinguish cell from coaching.

created-at, updated-at, closed-at, multiplied-at, is-online, slug,
online-location, is-closed, closed-by-admin, is-public, has-multiplied,
group-type, name, nickname, description, avatar-hash, avatar-source,
closing-note, gender-category, group-position, interval, weekday,
starts-at, ends-at, age-group-bottom, age-group-top, address, settings,
recess

The following nested fields can also be present:

details.goals.multiplication-date
details.goals.ideal-size
multiplication.current-group
multiplication.awaiting-approval
multiplication.approved
Name Cardinality Resource type
church-campus To one church-campuses
leaders To many people
upcoming-leaders To many people
participants To many people
previous-participants To many people
consolidators To many people
host To one people
future-host To one people
pair-group To one groups
group-above To one groups
groups-below To many groups
parent-group To one groups
child-groups To many groups
future-groups To many groups
multiplied-by To one people
multiplied-from To one groups
multiplied-with To many groups

Internal event summaries, organizing-role data, multiplication history, cached hierarchy snapshots, and derived labels are not included. Cell multiplication prototypes do not produce webhook events.

Used by cell-meeting.created and cell-meeting.updated. Only group events whose exact type is a cell meeting are eligible.

created-at, updated-at, name, date, description, is-public, is-online,
canceled, cancellation-notice, had-supervisor-presence, cell-offering,
meeting-photo-url, meeting-photo-thumb-url, meeting-photo-hash,
meeting-photo-caption, details.presence-of-god
Name Cardinality Resource type
group To one groups
attendees To many people
guests To many people
speaker To one people

Comments, creators/modifiers, root-group caches, and other free-form details fields are not included.

person.merged has additional top-level relationships and included resources:

  • relationships.subject identifies the person-mergers resource.
  • relationships.survivor identifies the person kept by the merge.
  • relationships.removed-person identifies the person removed by the merge.
  • included[0] is the person-mergers snapshot with completed-at, imported-fields, and its two relationships.
  • included[1] is the curated post-merge snapshot of the surviving person.
  • included[2] is a minimal snapshot of the removed person containing only name and full-name when available.

The relationship portion of the event has this shape:

{
"data": {
"type": "webhook-events",
"id": "66a000000000000000000001",
"attributes": {
"event-type": "person.merged",
"schema-version": 1,
"occurred-at": "2026-08-16T15:00:00.000Z"
},
"relationships": {
"subject": {
"data": { "type": "person-mergers", "id": "66f000000000000000000001" }
},
"survivor": {
"data": { "type": "people", "id": "66d000000000000000000001" }
},
"removed-person": {
"data": { "type": "people", "id": "66d000000000000000000002" }
}
}
}
}

Each to-many relationship contains at most 500 identifiers. If a relationship has more, the complete event includes metadata like:

{
"data": {
"attributes": {
"truncation": {
"relationships": {
"participants": {
"truncated": true,
"total": 725,
"included": 500
}
}
}
}
}
}

Treat a truncated relationship as an incomplete snapshot and use the REST API if your integration needs the complete relationship.