Webhook event catalogue

Teachings events

teaching.created#

Carries contentA teaching was added by upload, link, YouTube, Drive or a finished live service.

Carries what the REST read of the same resource returns for a key with the matching read scope: titles, summaries, sections and references. Never secrets.

data.object.object is teaching.

Fields of data.object for teaching.created
Field	Type	Description
`created_at` required	`string (date-time)`	When the teaching was added.
`duration_seconds` required	`integer`	The spoken length in seconds.
`failure_reason` required	`string`	A short plain reason when it failed, empty otherwise.
`guest_affiliation` required	`string`	The guest speaker's church or organisation.
`id` required	`string`	The teaching id.
`is_guest` required	`boolean`	True when the speaker is a guest.
`name` required	`string`	The teaching title, as every reference object names itself.
`object` required	`enum: teaching`	Always teaching.
`passage` required	`string`	The main passage, empty when none was set.
`possible_duplicate_of`	`object`	A teaching Folio thinks this repeats.
`id` required	`string`	The other teaching id.
`reason` required	`string`	Why they look alike.
`title` required	`string`	The other teaching title.
`progress`	`object`	How far processing has got.
`current` required	`object \| null`	The step running now, null when none.
`finished_at`	`string (date-time)`	When the step finished.
`key` required	`string`	The step key.
`label` required	`string`	The step name shown to the team.
`note` required	`string`	A short plain note about the step.
`started_at`	`string (date-time)`	When the step began.
`state` required	`string`	Where the step stands: pending, active, waiting, decision, done, skipped or failed.
`needs_decision` required	`boolean`	True when a person must decide something before it continues.
`steps` required	`object[]`	The processing steps in order.
`finished_at`	`string (date-time)`	When the step finished.
`key` required	`string`	The step key.
`label` required	`string`	The step name shown to the team.
`note` required	`string`	A short plain note about the step.
`started_at`	`string (date-time)`	When the step began.
`state` required	`string`	Where the step stands: pending, active, waiting, decision, done, skipped or failed.
`recorded_at` required	`string (date-time) \| null`	When it was recorded.
`series` required	`string`	The series it belongs to, empty when none.
`source` required	`object \| null`	Where it came from, null for a one-off upload.
`id` required	`string`	The source id.
`kind` required	`string`	upload, link, youtube, drive or live.
`name` required	`string`	The source name.
`object` required	`enum: source`	Always source.
`speaker` required	`string`	The speaker, empty when unknown.
`speaker_evidence` required	`string`	Why Folio guessed that speaker, empty when it did not.
`speaker_inferred` required	`boolean`	True when Folio guessed the speaker from the recording.
`status` required	`enum: awaiting_upload \| queued \| ingested \| resolving \| processing \| ready \| failed`	Where processing stands.
`status_note` required	`string`	A short plain note about the current status.
`title` required	`string`	The teaching title.
`transcript_changed` required	`boolean`	True when the transcript was edited after the notes were written.

Example teaching.created body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "created_at": "2026-10-13T09:12:10Z",
      "duration_seconds": 2412,
      "failure_reason": "",
      "guest_affiliation": "",
      "id": "tch_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "is_guest": false,
      "name": "Romans 8: Nothing can separate us",
      "object": "teaching",
      "passage": "Romans 8:31-39",
      "possible_duplicate_of": {
        "id": "tch_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9099",
        "reason": "same recording length and transcript",
        "title": "Romans 8: Nothing can separate us"
      },
      "progress": {
        "current": {
          "finished_at": "2026-10-13T09:12:10Z",
          "key": "transcribe",
          "label": "Transcribing",
          "note": "",
          "started_at": "2026-10-13T09:12:10Z",
          "state": "done"
        },
        "needs_decision": false,
        "steps": [
          {
            "finished_at": "2026-10-13T09:12:10Z",
            "key": "transcribe",
            "label": "Transcribing",
            "note": "",
            "started_at": "2026-10-13T09:12:10Z",
            "state": "done"
          }
        ]
      },
      "recorded_at": "2026-10-11T10:00:00Z",
      "series": "Romans",
      "source": {
        "id": "src_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "kind": "upload",
        "name": "Sunday uploads",
        "object": "source"
      },
      "speaker": "Pastor Ada Okafor",
      "speaker_evidence": "",
      "speaker_inferred": false,
      "status": "ready",
      "status_note": "",
      "title": "Romans 8: Nothing can separate us",
      "transcript_changed": false
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "teaching.created"
}

teaching.ready#

Carries contentA teaching finished processing and is searchable.

Carries what the REST read of the same resource returns for a key with the matching read scope: titles, summaries, sections and references. Never secrets.

data.object.object is teaching.

Fields of data.object for teaching.ready
Field	Type	Description
`created_at` required	`string (date-time)`	When the teaching was added.
`duration_seconds` required	`integer`	The spoken length in seconds.
`failure_reason` required	`string`	A short plain reason when it failed, empty otherwise.
`guest_affiliation` required	`string`	The guest speaker's church or organisation.
`id` required	`string`	The teaching id.
`is_guest` required	`boolean`	True when the speaker is a guest.
`name` required	`string`	The teaching title, as every reference object names itself.
`object` required	`enum: teaching`	Always teaching.
`passage` required	`string`	The main passage, empty when none was set.
`possible_duplicate_of`	`object`	A teaching Folio thinks this repeats.
`id` required	`string`	The other teaching id.
`reason` required	`string`	Why they look alike.
`title` required	`string`	The other teaching title.
`progress`	`object`	How far processing has got.
`current` required	`object \| null`	The step running now, null when none.
`finished_at`	`string (date-time)`	When the step finished.
`key` required	`string`	The step key.
`label` required	`string`	The step name shown to the team.
`note` required	`string`	A short plain note about the step.
`started_at`	`string (date-time)`	When the step began.
`state` required	`string`	Where the step stands: pending, active, waiting, decision, done, skipped or failed.
`needs_decision` required	`boolean`	True when a person must decide something before it continues.
`steps` required	`object[]`	The processing steps in order.
`finished_at`	`string (date-time)`	When the step finished.
`key` required	`string`	The step key.
`label` required	`string`	The step name shown to the team.
`note` required	`string`	A short plain note about the step.
`started_at`	`string (date-time)`	When the step began.
`state` required	`string`	Where the step stands: pending, active, waiting, decision, done, skipped or failed.
`recorded_at` required	`string (date-time) \| null`	When it was recorded.
`series` required	`string`	The series it belongs to, empty when none.
`source` required	`object \| null`	Where it came from, null for a one-off upload.
`id` required	`string`	The source id.
`kind` required	`string`	upload, link, youtube, drive or live.
`name` required	`string`	The source name.
`object` required	`enum: source`	Always source.
`speaker` required	`string`	The speaker, empty when unknown.
`speaker_evidence` required	`string`	Why Folio guessed that speaker, empty when it did not.
`speaker_inferred` required	`boolean`	True when Folio guessed the speaker from the recording.
`status` required	`enum: awaiting_upload \| queued \| ingested \| resolving \| processing \| ready \| failed`	Where processing stands.
`status_note` required	`string`	A short plain note about the current status.
`title` required	`string`	The teaching title.
`transcript_changed` required	`boolean`	True when the transcript was edited after the notes were written.

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

Example teaching.ready body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "created_at": "2026-10-13T09:12:10Z",
      "duration_seconds": 2412,
      "failure_reason": "",
      "guest_affiliation": "",
      "id": "tch_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "is_guest": false,
      "name": "Romans 8: Nothing can separate us",
      "object": "teaching",
      "passage": "Romans 8:31-39",
      "possible_duplicate_of": {
        "id": "tch_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9099",
        "reason": "same recording length and transcript",
        "title": "Romans 8: Nothing can separate us"
      },
      "progress": {
        "current": {
          "finished_at": "2026-10-13T09:12:10Z",
          "key": "transcribe",
          "label": "Transcribing",
          "note": "",
          "started_at": "2026-10-13T09:12:10Z",
          "state": "done"
        },
        "needs_decision": false,
        "steps": [
          {
            "finished_at": "2026-10-13T09:12:10Z",
            "key": "transcribe",
            "label": "Transcribing",
            "note": "",
            "started_at": "2026-10-13T09:12:10Z",
            "state": "done"
          }
        ]
      },
      "recorded_at": "2026-10-11T10:00:00Z",
      "series": "Romans",
      "source": {
        "id": "src_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "kind": "upload",
        "name": "Sunday uploads",
        "object": "source"
      },
      "speaker": "Pastor Ada Okafor",
      "speaker_evidence": "",
      "speaker_inferred": false,
      "status": "ready",
      "status_note": "",
      "title": "Romans 8: Nothing can separate us",
      "transcript_changed": false
    },
    "previous_attributes": {
      "duration_seconds": 2411,
      "status": "awaiting_upload"
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "teaching.ready"
}

teaching.failed#

Carries contentA teaching could not be processed.

Carries what the REST read of the same resource returns for a key with the matching read scope: titles, summaries, sections and references. Never secrets.

data.object.object is teaching.

Fields of data.object for teaching.failed
Field	Type	Description
`created_at` required	`string (date-time)`	When the teaching was added.
`duration_seconds` required	`integer`	The spoken length in seconds.
`failure_reason` required	`string`	A short plain reason when it failed, empty otherwise.
`guest_affiliation` required	`string`	The guest speaker's church or organisation.
`id` required	`string`	The teaching id.
`is_guest` required	`boolean`	True when the speaker is a guest.
`name` required	`string`	The teaching title, as every reference object names itself.
`object` required	`enum: teaching`	Always teaching.
`passage` required	`string`	The main passage, empty when none was set.
`possible_duplicate_of`	`object`	A teaching Folio thinks this repeats.
`id` required	`string`	The other teaching id.
`reason` required	`string`	Why they look alike.
`title` required	`string`	The other teaching title.
`progress`	`object`	How far processing has got.
`current` required	`object \| null`	The step running now, null when none.
`finished_at`	`string (date-time)`	When the step finished.
`key` required	`string`	The step key.
`label` required	`string`	The step name shown to the team.
`note` required	`string`	A short plain note about the step.
`started_at`	`string (date-time)`	When the step began.
`state` required	`string`	Where the step stands: pending, active, waiting, decision, done, skipped or failed.
`needs_decision` required	`boolean`	True when a person must decide something before it continues.
`steps` required	`object[]`	The processing steps in order.
`finished_at`	`string (date-time)`	When the step finished.
`key` required	`string`	The step key.
`label` required	`string`	The step name shown to the team.
`note` required	`string`	A short plain note about the step.
`started_at`	`string (date-time)`	When the step began.
`state` required	`string`	Where the step stands: pending, active, waiting, decision, done, skipped or failed.
`recorded_at` required	`string (date-time) \| null`	When it was recorded.
`series` required	`string`	The series it belongs to, empty when none.
`source` required	`object \| null`	Where it came from, null for a one-off upload.
`id` required	`string`	The source id.
`kind` required	`string`	upload, link, youtube, drive or live.
`name` required	`string`	The source name.
`object` required	`enum: source`	Always source.
`speaker` required	`string`	The speaker, empty when unknown.
`speaker_evidence` required	`string`	Why Folio guessed that speaker, empty when it did not.
`speaker_inferred` required	`boolean`	True when Folio guessed the speaker from the recording.
`status` required	`enum: awaiting_upload \| queued \| ingested \| resolving \| processing \| ready \| failed`	Where processing stands.
`status_note` required	`string`	A short plain note about the current status.
`title` required	`string`	The teaching title.
`transcript_changed` required	`boolean`	True when the transcript was edited after the notes were written.

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

Example teaching.failed body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "created_at": "2026-10-13T09:12:10Z",
      "duration_seconds": 2412,
      "failure_reason": "",
      "guest_affiliation": "",
      "id": "tch_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "is_guest": false,
      "name": "Romans 8: Nothing can separate us",
      "object": "teaching",
      "passage": "Romans 8:31-39",
      "possible_duplicate_of": {
        "id": "tch_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9099",
        "reason": "same recording length and transcript",
        "title": "Romans 8: Nothing can separate us"
      },
      "progress": {
        "current": {
          "finished_at": "2026-10-13T09:12:10Z",
          "key": "transcribe",
          "label": "Transcribing",
          "note": "",
          "started_at": "2026-10-13T09:12:10Z",
          "state": "done"
        },
        "needs_decision": false,
        "steps": [
          {
            "finished_at": "2026-10-13T09:12:10Z",
            "key": "transcribe",
            "label": "Transcribing",
            "note": "",
            "started_at": "2026-10-13T09:12:10Z",
            "state": "done"
          }
        ]
      },
      "recorded_at": "2026-10-11T10:00:00Z",
      "series": "Romans",
      "source": {
        "id": "src_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "kind": "upload",
        "name": "Sunday uploads",
        "object": "source"
      },
      "speaker": "Pastor Ada Okafor",
      "speaker_evidence": "",
      "speaker_inferred": false,
      "status": "ready",
      "status_note": "",
      "title": "Romans 8: Nothing can separate us",
      "transcript_changed": false
    },
    "previous_attributes": {
      "status": "awaiting_upload"
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "teaching.failed"
}

teaching.retired#

Carries contentA teaching was deleted from the library. The object is its last state.

Carries what the REST read of the same resource returns for a key with the matching read scope: titles, summaries, sections and references. Never secrets.

data.object.object is teaching.

Fields of data.object for teaching.retired
Field	Type	Description
`created_at` required	`string (date-time)`	When the teaching was added.
`duration_seconds` required	`integer`	The spoken length in seconds.
`failure_reason` required	`string`	A short plain reason when it failed, empty otherwise.
`guest_affiliation` required	`string`	The guest speaker's church or organisation.
`id` required	`string`	The teaching id.
`is_guest` required	`boolean`	True when the speaker is a guest.
`name` required	`string`	The teaching title, as every reference object names itself.
`object` required	`enum: teaching`	Always teaching.
`passage` required	`string`	The main passage, empty when none was set.
`possible_duplicate_of`	`object`	A teaching Folio thinks this repeats.
`id` required	`string`	The other teaching id.
`reason` required	`string`	Why they look alike.
`title` required	`string`	The other teaching title.
`progress`	`object`	How far processing has got.
`current` required	`object \| null`	The step running now, null when none.
`finished_at`	`string (date-time)`	When the step finished.
`key` required	`string`	The step key.
`label` required	`string`	The step name shown to the team.
`note` required	`string`	A short plain note about the step.
`started_at`	`string (date-time)`	When the step began.
`state` required	`string`	Where the step stands: pending, active, waiting, decision, done, skipped or failed.
`needs_decision` required	`boolean`	True when a person must decide something before it continues.
`steps` required	`object[]`	The processing steps in order.
`finished_at`	`string (date-time)`	When the step finished.
`key` required	`string`	The step key.
`label` required	`string`	The step name shown to the team.
`note` required	`string`	A short plain note about the step.
`started_at`	`string (date-time)`	When the step began.
`state` required	`string`	Where the step stands: pending, active, waiting, decision, done, skipped or failed.
`recorded_at` required	`string (date-time) \| null`	When it was recorded.
`series` required	`string`	The series it belongs to, empty when none.
`source` required	`object \| null`	Where it came from, null for a one-off upload.
`id` required	`string`	The source id.
`kind` required	`string`	upload, link, youtube, drive or live.
`name` required	`string`	The source name.
`object` required	`enum: source`	Always source.
`speaker` required	`string`	The speaker, empty when unknown.
`speaker_evidence` required	`string`	Why Folio guessed that speaker, empty when it did not.
`speaker_inferred` required	`boolean`	True when Folio guessed the speaker from the recording.
`status` required	`enum: awaiting_upload \| queued \| ingested \| resolving \| processing \| ready \| failed`	Where processing stands.
`status_note` required	`string`	A short plain note about the current status.
`title` required	`string`	The teaching title.
`transcript_changed` required	`boolean`	True when the transcript was edited after the notes were written.

Example teaching.retired body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "created_at": "2026-10-13T09:12:10Z",
      "duration_seconds": 2412,
      "failure_reason": "",
      "guest_affiliation": "",
      "id": "tch_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "is_guest": false,
      "name": "Romans 8: Nothing can separate us",
      "object": "teaching",
      "passage": "Romans 8:31-39",
      "possible_duplicate_of": {
        "id": "tch_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9099",
        "reason": "same recording length and transcript",
        "title": "Romans 8: Nothing can separate us"
      },
      "progress": {
        "current": {
          "finished_at": "2026-10-13T09:12:10Z",
          "key": "transcribe",
          "label": "Transcribing",
          "note": "",
          "started_at": "2026-10-13T09:12:10Z",
          "state": "done"
        },
        "needs_decision": false,
        "steps": [
          {
            "finished_at": "2026-10-13T09:12:10Z",
            "key": "transcribe",
            "label": "Transcribing",
            "note": "",
            "started_at": "2026-10-13T09:12:10Z",
            "state": "done"
          }
        ]
      },
      "recorded_at": "2026-10-11T10:00:00Z",
      "series": "Romans",
      "source": {
        "id": "src_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "kind": "upload",
        "name": "Sunday uploads",
        "object": "source"
      },
      "speaker": "Pastor Ada Okafor",
      "speaker_evidence": "",
      "speaker_inferred": false,
      "status": "ready",
      "status_note": "",
      "title": "Romans 8: Nothing can separate us",
      "transcript_changed": false
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "teaching.retired"
}

transcript.ready#

Carries contentA transcript was stored and selected for a teaching.

Carries what the REST read of the same resource returns for a key with the matching read scope: titles, summaries, sections and references. Never secrets.

data.object.object is transcript.

Fields of data.object for transcript.ready
Field	Type	Description
`character_count` required	`integer`	How many characters of text it holds.
`created_at` required	`string (date-time)`	When it was stored.
`id` required	`string`	The transcript id.
`language` required	`string`	The transcript language.
`object` required	`enum: transcript`	Always transcript.
`origin` required	`enum: live \| batch \| captions_import \| provider \| manual`	Where the words came from.
`segment_count` required	`integer`	How many timed segments it holds.
`teaching` required	`object`	The teaching it belongs to.
`id` required	`string`	The teaching id.
`name` required	`string`	The teaching title, as every reference object names itself.
`object` required	`enum: teaching`	Always teaching.
`recorded_at` required	`string (date-time) \| null`	When the teaching was recorded.
`speaker` required	`string`	The speaker, empty when unknown.
`title` required	`string`	The teaching title.
`url` required	`string`	The API path that returns the full text.

Example transcript.ready body

{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "character_count": 38214,
      "created_at": "2026-10-13T09:12:10Z",
      "id": "trn_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "language": "en",
      "object": "transcript",
      "origin": "batch",
      "segment_count": 612,
      "teaching": {
        "id": "tch_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "name": "Romans 8: Nothing can separate us",
        "object": "teaching",
        "recorded_at": "2026-10-11T10:00:00Z",
        "speaker": "Pastor Ada Okafor",
        "title": "Romans 8: Nothing can separate us"
      },
      "url": "/v1/transcripts/trn_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012"
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "transcript.ready"
}

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