Event

Type: object
Event envelope — identical on the pull feed and on webhook deliveries. payload carries only the allowlisted fields of each type (for example enrollment.created → {enrollment_id, church_id, mode, value, reference, fund}; enrollment.activated → {expected_amount, expected_cycle}; the event catalog lists every type). For every enrollment.* event, entity_id identifies the enrollment. Activation is not proof of a deposit.
- church_id
  Type: string
  required
  
  Roster identifier of the church this record belongs to.
- entity_id
  Type: string
  required
  
  Identifier of the record that changed; the enrollment ID for enrollment.*, the donor session ID for partner_session.* and the church ID for church.*.
- event_id
  Type: string
  required
  
  Globally unique — the deduplication key.
- event_type
  Type: enum
  required
  
  Event types visible to the partner (feed and webhooks). church.onboarded arrives once per church, the first time the church becomes ready for paycheck giving: the same moment payout_ready turns true on GET /v1/churches/{id} and GET /v1/churches. If the church later stops being ready, no event is sent; read payout_ready. Churches that were already ready before Roster started sending church.onboarded do not receive it. Today it is sent in the sandbox only; in production, read payout_ready.
  
  values
  partner_session.created
  partner_session.opened
  partner_session.completed
  partner_session.expired
  church.created
  church.onboarded
  enrollment.created
  enrollment.activated
- livemode
  Type: boolean
  required
  
  true when the event comes from production (sk_live_ keys), false when it comes from the sandbox (sk_test_ keys). When one receiver gets events from both environments, use it to keep them apart.
- occurred_at
  Type: stringFormat: date-time
  required
  
  Business time of the event.
- payload
  Type: object
  required
  
  Field-allowlisted projection, per event type.

ActivityEventType

WebhookEndpointInput