Webhook event catalogue

Audience events

audience.subscriber_confirmed#

Metadata onlyA subscriber confirmed their email address.

Metadata only. No conversation or question text, no contact details, no names or email addresses of people, and no crisis content. Ids, kinds, states and times so you can open the record in Folio.

data.object.object is subscriber.

Fields of data.object for audience.subscriber_confirmed
Field	Type	Description
`channels` required	`object[]`	Consent state per channel. No addresses are sent.
`channel` required	`enum: email \| sms \| whatsapp`	The channel.
`state` required	`string`	Where consent stands: none, pending, active, granted, bounced, complained or unsubscribed.
`confirmed_at` required	`string (date-time) \| null`	When they confirmed.
`created_at` required	`string (date-time)`	When they signed up.
`id` required	`string`	The subscriber id.
`language` required	`string`	The language they receive.
`object` required	`enum: subscriber`	Always subscriber.
`source` required	`string`	How they signed up.
`status` required	`enum: pending \| active \| bounced \| complained \| unsubscribed \| erased`	The subscriber state.
`unsubscribed_at` required	`string (date-time) \| null`	When they opted out.

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

Example audience.subscriber_confirmed body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "channels": [
        {
          "channel": "email",
          "state": "active"
        }
      ],
      "confirmed_at": "2026-10-13T09:12:10Z",
      "created_at": "2026-10-13T09:12:10Z",
      "id": "sub_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "language": "en",
      "object": "subscriber",
      "source": "website",
      "status": "active",
      "unsubscribed_at": "2026-10-13T09:12:10Z"
    },
    "previous_attributes": {
      "status": "pending"
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "audience.subscriber_confirmed"
}

audience.subscriber_unsubscribed#

Metadata onlyA subscriber opted out.

Metadata only. No conversation or question text, no contact details, no names or email addresses of people, and no crisis content. Ids, kinds, states and times so you can open the record in Folio.

data.object.object is subscriber.

Fields of data.object for audience.subscriber_unsubscribed
Field	Type	Description
`channels` required	`object[]`	Consent state per channel. No addresses are sent.
`channel` required	`enum: email \| sms \| whatsapp`	The channel.
`state` required	`string`	Where consent stands: none, pending, active, granted, bounced, complained or unsubscribed.
`confirmed_at` required	`string (date-time) \| null`	When they confirmed.
`created_at` required	`string (date-time)`	When they signed up.
`id` required	`string`	The subscriber id.
`language` required	`string`	The language they receive.
`object` required	`enum: subscriber`	Always subscriber.
`source` required	`string`	How they signed up.
`status` required	`enum: pending \| active \| bounced \| complained \| unsubscribed \| erased`	The subscriber state.
`unsubscribed_at` required	`string (date-time) \| null`	When they opted out.

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

Example audience.subscriber_unsubscribed body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "channels": [
        {
          "channel": "email",
          "state": "active"
        }
      ],
      "confirmed_at": "2026-10-13T09:12:10Z",
      "created_at": "2026-10-13T09:12:10Z",
      "id": "sub_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "language": "en",
      "object": "subscriber",
      "source": "website",
      "status": "active",
      "unsubscribed_at": "2026-10-13T09:12:10Z"
    },
    "previous_attributes": {
      "status": "pending"
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "audience.subscriber_unsubscribed"
}

audience.subscriber_erased#

Metadata onlyA subscriber's personal data was erased on request. Only the id and consent history remain.

Metadata only. No conversation or question text, no contact details, no names or email addresses of people, and no crisis content. Ids, kinds, states and times so you can open the record in Folio.

data.object.object is subscriber.

Fields of data.object for audience.subscriber_erased
Field	Type	Description
`channels` required	`object[]`	Consent state per channel. No addresses are sent.
`channel` required	`enum: email \| sms \| whatsapp`	The channel.
`state` required	`string`	Where consent stands: none, pending, active, granted, bounced, complained or unsubscribed.
`confirmed_at` required	`string (date-time) \| null`	When they confirmed.
`created_at` required	`string (date-time)`	When they signed up.
`id` required	`string`	The subscriber id.
`language` required	`string`	The language they receive.
`object` required	`enum: subscriber`	Always subscriber.
`source` required	`string`	How they signed up.
`status` required	`enum: pending \| active \| bounced \| complained \| unsubscribed \| erased`	The subscriber state.
`unsubscribed_at` required	`string (date-time) \| null`	When they opted out.

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

Example audience.subscriber_erased body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "channels": [
        {
          "channel": "email",
          "state": "active"
        }
      ],
      "confirmed_at": "2026-10-13T09:12:10Z",
      "created_at": "2026-10-13T09:12:10Z",
      "id": "sub_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "language": "en",
      "object": "subscriber",
      "source": "website",
      "status": "active",
      "unsubscribed_at": "2026-10-13T09:12:10Z"
    },
    "previous_attributes": {
      "status": "pending"
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "audience.subscriber_erased"
}

audience.campaign_sent#

Metadata onlyA campaign was sent to its recipients.

Metadata only. No conversation or question text, no contact details, no names or email addresses of people, and no crisis content. Ids, kinds, states and times so you can open the record in Folio.

data.object.object is campaign.

Fields of data.object for audience.campaign_sent
Field	Type	Description
`channel` required	`enum: email \| sms \| whatsapp`	How it was sent.
`created_at` required	`string (date-time)`	When it was created.
`id` required	`string`	The campaign id.
`name` required	`string`	The label the church gave the campaign.
`object` required	`enum: campaign`	Always campaign.
`recipients` required	`integer`	How many people it went to.
`scheduled_at` required	`string (date-time) \| null`	When it was scheduled for.
`sent_at` required	`string (date-time) \| null`	When it was sent.
`status` required	`enum: draft \| scheduled \| sending \| sent \| cancelled`	Where the send stands.

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

Example audience.campaign_sent body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "channel": "email",
      "created_at": "2026-10-13T09:12:10Z",
      "id": "cmp_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "name": "Sunday recap",
      "object": "campaign",
      "recipients": 1240,
      "scheduled_at": "2026-10-13T09:12:10Z",
      "sent_at": "2026-10-13T09:12:10Z",
      "status": "sent"
    },
    "previous_attributes": {
      "status": "draft"
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "audience.campaign_sent"
}

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