Timer that sends messages to WebSocket connections

A timer is a trigger that sends messages to WebSocket connections on schedule. The schedule is entered as a cron expression. The cron expression uses UTC+0.

A timer requires a service account to send messages to WebSocket connections.

For more information about creating a timer, see Creating a timer that sends messages to WebSocket connections.

Cron expression formatCron expression format

The fields in a cron expression are ordered as follows: Minutes Hours Day-of-month Month Day-of-week Year.

Possible field valuesPossible field values

Special charactersSpecial characters

You can use the following special characters in cron expressions:

• *: Selects all values in the field.

  * in the Minutes field: Trigger fires every minute.

• ?: Selects any field value. You cannot specify Day of month and Day of week at the same time. If you have entered a value in one of these fields, put ? in the other one.

  10 in Day of month and ? in Day of week: Trigger fires on the 10th day of each month.

• -: Selects a range of values.

  10-12 in Hours: Trigger fires at 10 a.m., 11 a.m., and 12 p.m.

• ,: Selects multiple values.

  MON,WED,FRI in Day of week: Trigger fires on Monday, Wednesday, and Friday.

• /: Increments the value.

  0/15 in Minutes: Trigger fires at 0, 15, 30, and 45 minutes past each hour.

• L: This character has different meanings in the two fields it is valid for:

  • In the Day of month field, it means the last day of the month.
  • In the Day of week field, it means the last day of the week, 7 (Saturday, SAT).

  L in Day of month: Trigger fires on January 31, February 28, and so on.

• W: Selects the weekday nearest to the specified date.

  15W in Day of month: Trigger fires on the weekday nearest to the 15th day of the month. If the 15th day falls on Saturday, the trigger fires on Friday the 14th.

  Note

  L and W in the Day of month field can also merge into the LW combination, firing the trigger on the last weekday of the month.

• #: Selects the Nth day of the month.

  6#3 in Day of week: Trigger will fire on the third Friday of the month (6 for Friday; 3 for third Friday of the month).

Examples of cron expressionsExamples of cron expressions

Roles required for timers to run correctlyRoles required for timers to run correctly

• To create a timer, you need a permission for the service account under which the timer executes the operation. This permission comes with the iam.serviceAccounts.user and editor roles or higher.
• To activate a timer, the service account needs the api-gateway.websocketBroadcaster role for the folder containing the API gateway.

Read more about access management.

Timer message formatTimer message format

After the trigger fires, it will send the following message to WebSocket connections:

{
  "messages": [
    {
      "event_metadata": {
        "event_id": "a1s41g2n5g0o********",
        "event_type": "yandex.cloud.events.serverless.triggers.TimerMessage",
        "created_at": "2019-12-04T12:05:14.227761Z",
        "cloud_id": "b1gvlrnlei4l********",
        "folder_id": "b1g88tflru0e********"
      },
      "details": {
        "trigger_id": "a1sfe084v4se********",
        "payload": "payload-message"
      }
    }
  ]
}

See alsoSee also

• Timer to run a Serverless Containers container
• Timer to run a Cloud Functions function