Netlify Create ScheduledAction Type

The Typescript definition of the Netlify Create ScheduledAction type

ScheduledAction is available in the @stackbit/types package and used for defining custom scheduled actions in Netlify Create.

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
export interface ScheduledAction {
  /**
   * State of the schedule. Only scheduled schedules can be edited.
   */
  state: 'scheduled' | 'succeeded' | 'executing' | 'cancelled' | 'failed'
  /**
   * Display name of the schedule.
   */
  name: string
  /**
   * Currently only publish is supported.
   */
  action: 'publish'
  /**
   * Creation date of the schedule as an ISO string UTC
   * (YYYY-MM-DDTHH:mm:ss.sssZ)
   */
  createdAt: string
  /**
   * userId of the author of the schedule
   */
  createdBy: string
  /**
   * Date the action will be executed, as an ISO string UTC
   * (YYYY-MM-DDTHH:mm:ss.sssZ)
   */
  executeAt: string
  /**
   * An array of document ids that will be published
   */
  documentIds: string[]
}

This type is currently used in the following methods: