onTaskOverdue( )

An event that triggers when a task reaches its due date.

Description

The onTaskOverdue() event handler runs when a task reaches its due date. The received TaskOverdueEvent object contains information about the task that was updated.

Note: Backend events don't work when previewing your site.

Syntax

function wixCrmTasks_onTaskOverdue(event: TaskOverdueEvent): void

onTaskOverdue Parameters

NAME

TYPE

DESCRIPTION

event

Optional

TaskOverdueEvent

Information about the task that's overdue and metadata for the event.

Returns

This function does not return anything.

Return Type:

void

Was this helpful?

An event fired when a task reaches its due date

Copy Code

1// Place this code in the events.js file
2// of your site's Backend section.
3// Add the file if it doesn't exist.
4
5export function wixCrmTasks_onTaskOverdue(event) {
6  const eventId = event.metadata.id;
7  const entityId = event.entity._id;
8  const title = event.entity.title;
9  console.log('Task overdue', event);
10}
11
12/* Full event object: 
13 * {
14 *   "metadata": {
15 *     "id": "f772aff2-2c04-4677-968b-2727635ec62c",
16 *     "entityId": "f79fe92b-2482-4884-8cef-53e016506bf7",
17 *     "eventTime": "2024-02-10T10:00:00.000Z",
18 *     "triggeredByAnonymizeRequest": false
19 *   },
20 *   "entity": {
21 *     "revision": "2",
22 *     "title": "Follow up",
23 *     "dueDate": "2024-02-10T10:00:00.000Z",
24 *     "status": "ACTION_NEEDED",
25 *     "source": {
26 *       "sourceType": "USER",
27 *       "userId": "162e6672-d392-42f8-bf79-999ee633c92a"
28 *     },
29 *     "_id": "f79fe92b-2482-4884-8cef-53e016506bf7",
30 *     "_createdDate": "2024-02-13T06:43:44.624Z",
31 *     "_updatedDate": "2024-02-13T06:58:12.896Z"
32 *   }
33 * }
34 */