Type alias ScheduledActionProps

Type declaration

• action: SchedulableActionType

• entity: Link<SchedulableEntityType>

• Optional environment?: {
      sys: MetaLinkProps;
  }

  • sys: MetaLinkProps

• Optional error?: ScheduledActionFailedError

  The Contentful-style error that occurred during execution if sys.status is failed

  Example

  {
     *   sys: {
     *     type: 'Error',
     *     id: 'InvalidEntry'
     *   },
     *   message: 'Entry is invalid',
     *   details: {
     *     errors: [...]
     *   }
     * }
  

• Optional payload?: ScheduledActionPayloadProps

• scheduledFor: {
      datetime: ISO8601Timestamp;
      timezone?: string;
  }

  • datetime: ISO8601Timestamp

  • Optional timezone?: string

    A valid IANA timezone Olson identifier

    See

    https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

    Example

    'Asia/Kolkata'
    

• sys: ScheduledActionSysProps