Skip to content
FolioSign inStart your trial

Webhook event catalogue

Scripture events

2 events. All groups

scripture.indexed#

Carries contentThe scripture references in an approved note were found and linked to verses.

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

Fields of data.object for scripture.indexed
FieldTypeDescription
citation_count requiredintegerReferences that were verified and stored.
created_at requiredstring (date-time)When the run started.
dropped_count requiredintegerReferences that were set aside because they did not check out.
finished_at requiredstring (date-time) | nullWhen the run finished.
id requiredstringThe extraction id.
note requiredobjectThe note that was read.
id requiredstringThe note id.
object requiredenum: noteAlways note.
status requiredenum: draft | in_review | approved | published | superseded | failedThe note status.
object requiredenum: scripture_extractionAlways scripture_extraction.
status requiredenum: queued | running | succeeded | failedHow the run ended.
teaching requiredobjectThe teaching the note belongs to.
id requiredstringThe teaching id.
name requiredstringThe teaching title, as every reference object names itself.
object requiredenum: teachingAlways teaching.
recorded_at requiredstring (date-time) | nullWhen the teaching was recorded.
speaker requiredstringThe speaker, empty when unknown.
title requiredstringThe teaching title.
Example scripture.indexed body
{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "citation_count": 14,
      "created_at": "2026-10-13T09:12:10Z",
      "dropped_count": 1,
      "finished_at": "2026-10-13T09:12:10Z",
      "id": "ext_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "note": {
        "id": "note_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "object": "note",
        "status": "approved"
      },
      "object": "scripture_extraction",
      "status": "succeeded",
      "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"
      }
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "scripture.indexed"
}

scripture.tension_detected#

Carries contentA new teaching point seems to pull against earlier teaching on the same verse and needs a person to look.

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

Fields of data.object for scripture.tension_detected
FieldTypeDescription
citation requiredobjectThe citation that conflicts.
id requiredstringThe citation id.
object requiredenum: citationAlways citation.
reference requiredstringThe verse reference.
verse_id requiredintegerThe verse, numbered across the whole Bible.
created_at requiredstring (date-time)When it was flagged.
id requiredstringThe tension id.
object requiredenum: tensionAlways tension.
reason requiredstringWhy it was flagged, in one sentence.
status requiredenum: open | resolved | dismissedWhere review stands.
teaching requiredobjectThe teaching that raised it.
id requiredstringThe teaching id.
name requiredstringThe teaching title, as every reference object names itself.
object requiredenum: teachingAlways teaching.
recorded_at requiredstring (date-time) | nullWhen the teaching was recorded.
speaker requiredstringThe speaker, empty when unknown.
title requiredstringThe teaching title.
Example scripture.tension_detected body
{
  "actor": null,
  "api_version": "2026-12-01",
  "created": "2026-10-13T09:12:10Z",
  "data": {
    "object": {
      "citation": {
        "id": "cit_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
        "object": "citation",
        "reference": "Romans 8:28",
        "verse_id": 28106
      },
      "created_at": "2026-10-13T09:12:10Z",
      "id": "ten_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
      "object": "tension",
      "reason": "This point says the promise is conditional; earlier teaching says it is not.",
      "status": "open",
      "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"
      }
    }
  },
  "id": "evt_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012",
  "livemode": false,
  "object": "event",
  "request": {
    "id": "req_5f3c9a1e7b2d4c68a0e1f2d3c4b5a697",
    "idempotency_key": null
  },
  "type": "scripture.tension_detected"
}

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