Skip to main content

Workflow

Stored in the workflows collection. createdAt and updatedAt are maintained automatically.

Returned by DELETE /workflow, POST /workflow, DELETE /workflow/:id, GET /workflow/:id, PUT /workflow/:id, POST /workflow/:id/publish and 2 more.

FieldTypeNotes
namestringrequired
normalizedNamestring
activeNamestring
companyObjectId -> Companyrequired
triggerEventTypestring
statusstringdefault draft · one of draft, published, paused, archived
publishedVersionnumberdefault 0
latestVersionnumberdefault 1
configanydefault {}
publishedSnapshotanydefault null
publishedAtdate
schedule.minutestringdefault *
schedule.hourstringdefault *
schedule.dayOfMonthstringdefault *
schedule.monthstringdefault *
schedule.dayOfWeekstringdefault *
createdByObjectId -> Member
updatedByObjectId -> Member
_idObjectIddefault "6a95712f932657988a91c0fc"
createdAtdateset once
updatedAtdate