Freshworks Developer Platform Docs

onTimeSheetCreate

When a time entry is added to a ticket, problem, change, or release, the onTimesheetCreate event is invoked and the registered callback method is executed.

Subscribe to the onTimesheetCreate event and register the callback by using the following sample manifest.json content.

manifest.json

"events": {
  "onTimesheetCreate": {
      "handler": "onTimesheetCreateCallback"
  }
}

Define the corresponding callback by using the following sample server.js content:

server.js

exports = {
  onTimesheetCreateCallback: function(payload) {
    console.log("Logging arguments from onTimesheetCreate event: " + JSON.stringify(payload));
  }
}

Attributes of the data object

actorobject
Information pertaining to the system, agent, or requester who triggered the onTimesheetCreate event in the Freshservice system.
- profile_idinteger
  Identifier of the actor who triggered the product event.
taskobject
A task works as a checklist that can be delegated to other teams. For instance, if you receive a ticket requiring actions from another team before resolution, you can create a task, assign it to the appropriate agent, and set a due date. To learn more about tasks, see Tasks.

This attribute contains information pertaining to the task for whom the time entry is created.
- idinteger
  Identifier of the task object.
timesheetobject
Information pertaining to the time entry in the Freshservice system.
- agent_idinteger
  Identifier of the agent to whom the time entry is currently assigned.
- billableboolean
  Specifies whether the time entry is billable.
  Possible values: true, false
- created_atstring
  Timestamp indicating when the time entry was created, specified in the ISO-8601 format.
- custom_fieldsobject
  To obtain additional time entry information, custom fields could be configured in the Freshworks system.
  
  The custom_fields attribute contains the custom field names and corresponding values, as a valid JSON object of key (custom field name)-value (custom field’s value) pairs.
  
  For more information about custom fields in time entries, see Adding custom fields for time entries.
- executed_atstring
  Timestamp indicating the actual start time entered by the agent in the Add time section, specified in the ISO-8601 format.
  
  If the agent edits or updates the start time, the executed_at value will be updated to match this new start time, making it a dynamic field that captures any changes the agent makes.
- idinteger
  Identifier of the time entry object, auto-generated when a time entry is created in the Freshservice system.
- notestring
  Content added to the Note section of the time entry.
- note_truncatedboolean
  Specifies whether the content added to the note section of the time entry has been truncated.
  Possible values: true, false
- start_timestring
  Timestamp of when the timer for the time entry was initially started, specified in ISO-8601 format.
- time_spentinteger
  Duration of the timer set for the time entry, specified in seconds.
- timer_runningboolean
  Specifies whether the timer is currently running for the time entry.
  Possible values: true, false
- updated_atstring
  Timestamp of when the details for the time entry was updated, specified in ISO-8601 format.
  For onTimesheetCreate, this attribute value is the same as the created_at value.
- workable_typestring
  This attribute represents the entity for which the time entry is created. If a time entry is created for a task, the parent entity of that task is considered as workable.
- workspace_idinteger
  Important:When the onTimesheetCreate event is triggered in accounts without workspaces or with the MSP mode enabled, this attribute is not returned in the payload. MSP mode does not support workspaces.
  In accounts with workspaces, tickets/problem/change/release, belong to specific workspaces. A workspace is a configurable, team or department-specific space where team-members can collaborate while maintaining the operational integrity of team-only data.
  
  workspace_id is the identifier of the workspace where the tickets/problem/change/release is created. It is auto-generated when a new workspace is created in Freshservice. For information about workspaces, read What is a workspace. To retrieve all the workspaces that are created in an account, through APIs, use the List all workspaces API
  Note:workspace_id is displayed as part of the account URL when you (or the app user) navigate to the admin settings of the workspace. For example, when you navigate to the primary workspace’s admin settings, if the corresponding URL is /ws/2/admin/home, the workspace’s ID is 2.
- workableobject
  Information pertaining to the workable (parent entity) where the time sheet is created.
  idinteger
  Identifier of the object.

Sample payload

{
  "account_id": "1000000785",
  "data": {
    "actor": {
      "profile_id": 37665
    },
    "task": {
      "id": 24
    },
    "timesheet": {
      "agent_id": 37671,
      "billable": false,
      "created_at": "2024-09-02T01:59:04-04:00",
      "custom_fields": {
        "test_custom_central": "test text for timesheet create",
        "test_custom_date_local_peo": "2024-09-03",
        "test_custom_decimal_local_peo": "2.9",
        "test_custom_drop_local_peo": 1,
        "test_custom_paragraph_local_peo": "test paragraph content for timesheet create",
        "test_custom_url_local_peo": "http://vai-mkp-local.freshdev.com",
        "test_ts_custom_boolean": true,
        "test_ts_custom_number": 29,
        "test_ts_custom_number_2": 2924
      },
      "executed_at": "2024-09-02T01:57:00-04:00",
      "id": 19,
      "note": "test note for timesheet create",
      "note_truncated": false,
      "start_time": "2024-09-02T01:59:02-04:00",
      "time_spent": 7200,
      "timer_running": false,
      "updated_at": "2024-09-02T01:59:04-04:00",
      "workable_type": "Itil::Change",
      "workspace_id": 2
    },
    "workable": {
      "id": 7
    }
  },
  "domain": "vai-mkp-local.freshservice-dev.com",
  "event": "onTimesheetCreate",
  "region": "US",
  "timestamp": "1725256855728",
  "version": "1.0.0"
}

onTimeSheetUpdate

When a time entry of a ticket, problem, change, or release, is updated, the onTimesheetUpdate event is invoked and the registered callback method is executed.

Subscribe to the onTimesheetUpdate event and register the callback by using the following sample manifest.json content.

manifest.json

"events": {
  "onTimesheetUpdate": {
      "handler": "onTimesheetUpdateCallback"
  }
}

Define the corresponding callback by using the following sample server.js content:

server.js

exports = {
  onTimesheetUpdateCallback: function(payload) {
    console.log("Logging arguments from onTimesheetUpdate event: " + JSON.stringify(payload));
  }
}

Attributes of the data object

actorobject
Information pertaining to the system, agent, or requester who triggered the onTimesheetUpdate event in the Freshservice system.
- profile_idinteger
  Identifier of the actor who triggered the product event.
changesobject
Changes that triggered the onTimesheetUpdate event, specified as a JSON object of the following format:
```
"changes": {
  //For non-array attributes
  "<timesheet.attribute that changed>": ["Old value", "New value"]
}
```
Note:If the billable attribute or any custom attribute with a boolean data type is changed from false to true, the changes array for this attribute will display the prior and updated values as ["none", true]
taskobject
A task works as a checklist that can be delegated to other teams. For instance, if you receive a ticket requiring actions from another team before resolution, you can create a task, assign it to the appropriate agent, and set a due date. To learn more about tasks, see Tasks.

This attribute contains information pertaining to the task for whom the time entry is updated.
- idinteger
  Identifier of the task object.
timesheetobject
Information pertaining to the time entry in the Freshservice system.
- agent_idinteger
  Identifier of the agent to whom the time entry is currently assigned.
- billableboolean
  Specifies whether the time entry is billable.
  Possible values: true, false
- created_atstring
  Timestamp indicating when the time entry was created, specified in the ISO-8601 format.
- custom_fieldsobject
  To obtain additional time entry information, custom fields could be configured in the Freshworks system.
  
  The custom_fields attribute contains the custom field names and corresponding values, as a valid JSON object of key (custom field name)-value (custom field’s value) pairs.
  
  For more information about custom fields in time entries, see Adding custom fields for time entries.
- executed_atstring
  Timestamp indicating the actual start time entered by the agent in the Add time section, specified in the ISO-8601 format.
  
  If the agent edits or updates the start time, the executed_at value will be updated to match this new start time, making it a dynamic field that captures any changes the agent makes.
- idinteger
  Identifier of the time entry object, auto-generated when a time entry is created in the Freshservice system.
- notestring
  Content added to the Note section of the time entry.
- note_truncatedboolean
  Specifies whether the content added to the note section of the time entry has been truncated.
  Possible values: true, false
- start_timestring
  Timestamp of when the timer for the time entry was initially started, specified in ISO-8601 format.
- time_spentinteger
  Duration of the timer set for the time entry, specified in seconds.
- timer_runningboolean
  Specifies whether the timer is currently running for the time entry.
  Possible values: true, false
- updated_atstring
  Timestamp of when the details for the time entry was updated, specified in ISO-8601 format.
- workable_typestring
  This attribute represents the entity for which the time entry is created. If a time entry is created for a task, the parent entity of that task is considered as workable.
- workspace_idinteger
  Important:When the onTimesheetCreate event is triggered in accounts without workspaces or with the MSP mode enabled, this attribute is not returned in the payload. MSP mode does not support workspaces.
  In accounts with workspaces, tickets/problem/change/release, belong to specific workspaces. A workspace is a configurable, team or department-specific space where team-members can collaborate while maintaining the operational integrity of team-only data.
  
  workspace_id is the identifier of the workspace where the tickets/problem/change/release is updated. It is auto-generated when a new workspace is created in Freshservice. For information about workspaces, read What is a workspace. To retrieve all the workspaces that are created in an account, through APIs, use the List all workspaces API.
  Note:workspace_id is displayed as part of the account URL when you (or the app user) navigate to the admin settings of the workspace. For example, when you navigate to the primary workspace’s admin settings, if the corresponding URL is /ws/2/admin/home, the workspace’s ID is 2.
- workableobject
  Information pertaining to the workable (parent entity) where the time sheet is updated.
  idinteger
  Identifier of the object.

Sample payload

{
  "account_id": "1000000785",
  "data": {
    "actor": {
      "profile_id": 37665
    },
    "changes": {
      "billable": [
        "none",
        true
      ],
      "custom_fields": {
        "test_custom_central": [
          "*",
          "modified field"
        ],
        "test_custom_decimal_local_peo": [
          "2.9",
          "2.94"
        ],
        "test_custom_drop_local_peo": [
          "First Choice",
          "none"
        ],
        "test_custom_paragraph_local_peo": [
          "*",
          "modified field"
        ],
        "test_custom_url_local_peo": [
          "*",
          "modified field"
        ],
        "test_ts_custom_boolean": [
          "none",
          true
        ],
        "test_ts_custom_number": [
          29,
          2929
        ],
        "test_ts_custom_number_2": [
          "none",
          2924
        ]
      },
      "executed_at": [
          "2024-09-02T01:57:00-04:00",
          "2024-09-03T00:00:00-04:00"
      ],
      "note": [
          "*",
          "modified field"
      ]
    },
    "task": {
      "id": 24
    },
    "timesheet": {
      "agent_id": 37671,
      "billable": true,
      "created_at": "2024-09-02T01:59:04-04:00",
      "custom_fields": {
        "test_custom_central": "test text for timesheet create updated",
        "test_custom_date_local_peo": "2024-09-03",
        "test_custom_decimal_local_peo": "2.94",
        "test_custom_drop_local_peo": null,
        "test_custom_paragraph_local_peo": "test paragraph content for timesheet create updated",
        "test_custom_url_local_peo": "",
        "test_ts_custom_boolean": false,
        "test_ts_custom_number": 2929,
        "test_ts_custom_number_2": null
      },
      "executed_at": "2024-09-03T00:00:00-04:00",
      "id": 19,
      "note": "test note for timesheet create updated",
      "note_truncated": false,
      "start_time": "2024-09-02T01:59:02-04:00",
      "time_spent": 7200,
      "timer_running": false,
      "updated_at": "2024-09-02T02:32:09-04:00",
      "workable_type": "Itil::Change",
      "workspace_id": 2
    },
    "workable": {
      "id": 7
    }
  },
  "domain": "vai-mkp-local.freshservice-dev.com",
  "event": "onTimesheetUpdate",
  "region": "US",
  "timestamp": "1725258772274",
  "version": "1.0.0"
}

Configure onTimeSheetCreate and onTimeSheetUpdate

onTimeSheetCreate

Attributes of the data object

onTimeSheetUpdate

Attributes of the data object