Subscribed Events is an add-on API feature that records up to 7 days of trackable changes in your account. With Subscribed Events, you can see detailed information about things that were created, updated, and deleted on your account.
User Permissions Needed: Account Administrator
INFO
To enable Subscribed Events, please contact your Client Success Manager (CSM). You must be an Account Administrator to request this feature.
Subscribed Events is an add-on API feature that records up to 7 days of trackable changes in your account. With Subscribed Events, you can see detailed information about things that were created, updated, and deleted on your account. For example, you can see when time entries were deleted, when scheduled hours on projects were changed, when project settings were updated, and much more.
Subscribed Events lets you check who did what, allowing you to better control how you manage your projects and data. You can also see the before and after states of data for each event, which helps you to restore data or revert changes if needed.
Note: Subscribed Events retain up to 7 days of events. It’s possible that we may change the retention period. Before any change is made, we will notify you in advance.
The following tables are a reference of all the trackable changes available in Subscribed Events and the tracked properties of each event. For descriptions of the parameters and properties of the Subscribed Event object itself, please refer to the API documentation.
Account Color
Account Color |
Events |
Title |
Description |
account_color:created |
New Account Color |
When a new Account Color is created. |
account_color:deleted |
Deleted Account Color |
When an existing Account Color is deleted. |
account_color:updated |
Updated Account Color |
When an existing Account Color is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the account color. |
account_id |
integer |
The ID of the account which the account color belongs to. |
created_at |
date-time |
When the account color was created. |
default_color |
boolean |
Whether the account color is the default for the account. |
enabled |
boolean |
Whether the account color is enabled on the account. |
hex |
integer |
The hex code of the account color. |
name |
string |
The name of the account color. |
updated_at |
date-time |
When the account color was updated. |
Account Location
Account Location |
Events |
Title |
Description |
account_location:created |
New Account Location |
When a new Account Location is created. |
account_location:deleted |
Deleted Account Location |
When an existing Account Location is deleted. |
account_location:updated |
Updated Account Location |
When an existing Account Location is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the location. |
account_id |
integer |
The ID of the account which the location belongs to. |
archived_at |
date-time |
When the location was archived. |
created_at |
date-time |
When the location was created. |
name |
string |
The name of the location. |
updated_at |
date-time |
When the location was updated. |
Account Membership
Account Membership |
Events |
Title |
Description |
account_membership:created |
New Account Membership |
When a new Account Membership is created. |
account_membership:deleted |
Deleted Account Membership |
When an existing Account Membership is deleted. |
account_membership:updated |
Updated Account Membership |
When an existing Account Membership is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the account membership. |
account_id |
integer |
The ID of the account that the membership belongs to. |
bill_rate_in_subunits |
integer |
The default billing rate, in subunits, for the user in a workspace on this account when the workspace does not use rate card. |
can_create_workspace |
boolean |
Whether the user's account-level permission is Project Creator. |
can_log_in |
boolean |
Whether the user can log into Mavenlink. |
can_view_reports |
boolean |
Whether the user's account-level permission is Report Viewer. |
can_view_reports_with_cost |
boolean |
Whether the user's account-level permission is Report Viewer With Cost. |
created_at |
date-time |
When the user was added to the account. |
default_read_only |
boolean |
Whether the user has View Only access in projects by default. |
default_role_id |
integer |
The ID of the user's default account role. |
disabled_at |
date-time |
The date when the account membership was disabled. |
is_administrator |
boolean |
Whether the user's account-level permission is Account Administrator. |
is_owner |
boolean |
Whether the user is an account owner. |
is_project_lead |
boolean |
Whether the user's account-level permission is Project Lead. |
is_punch_clock_user |
boolean |
Whether the user's account-level permission is Punch Clock. |
updated_at |
date-time |
When the user was last updated. |
user_id |
integer |
The ID of the user. |
Account Role
Account Role |
Events |
Title |
Description |
role:created |
New Account Role |
When a new Account Role is created. |
role:deleted |
Deleted Account Role |
When an existing Account Role is deleted. |
role:updated |
Updated Account Role |
When an existing Account Role is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the role. |
account_id |
integer |
The ID of the account the role belongs to. |
created_at |
date-time |
When the role was created. |
deleted_at |
date-time |
When the role was deleted. |
name |
string |
The name of the role. |
updated_at |
date-time |
When the role was updated. |
Account Skill
Account Skill |
Events |
Title |
Description |
skill:created |
New Account Skill |
When a new Account Skill is created. |
skill:deleted |
Deleted Account Skill |
When an existing Account Skill is deleted. |
skill:updated |
Updated Account Skill |
When an existing Account Skill is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the skill. |
account_id |
integer |
The ID of the account the skill belongs to. |
created_at |
date-time |
When the skill was created. |
description |
string |
The description of the skill. |
max_level |
integer |
Whether the skill uses levels. (5 = uses levels, 1 = doesn't use levels) |
name |
string |
The name of the skill. |
skill_category_id |
integer |
The ID of the category the skill is in. |
updated_at |
date-time |
When the skill was updated. |
Estimate
Estimate - Custom Field Values |
Events |
Title |
Description |
estimate:custom_field_value_created |
New Custom Field Value for Estimate |
When a new Custom Field Value is created for an Estimate. |
estimate:custom_field_value_deleted |
Deleted Custom Field Value for Estimate |
When a Custom Field Value is deleted for an Estimate. |
estimate:custom_field_value_updated |
Updated Custom Field Value for Estimate |
When a Custom Field Value is updated for an Estimate. |
Properties |
Type |
Description |
account_id |
integer |
The ID of the account the custom field belongs to. |
custom_field_id |
integer |
The ID of the custom field the value is associated with. |
custom_field_name |
string |
The name of the custom field the value is associated with. |
custom_field_type |
string |
The type of the custom field the value is associated with. |
custom_field_values |
array |
The value or selected choices for the custom field on the object, in a serialized format. |
value |
string |
The value for the custom field on the object. |
choice_id |
integer |
The ID of the custom field choice selected for the custom field on the object. |
custom_field_value_id |
integer |
The ID of the custom field value. |
created_at |
date-time |
When the custom field value was created. |
display_value |
string |
The value or selected choices for the custom field on the object, in a display friendly format. |
subject_id |
integer |
The ID of the object the custom field value is on. |
subject_type |
string |
The type of the object the custom field value is on. |
updated_at |
date-time |
When the custom field value was updated. |
Estimate Scenario
Estimate Scenario |
Events |
Title |
Description |
estimate_scenario:created |
New Estimate Scenario |
When a new Estimate Scenario is created. |
estimate_scenario:deleted |
Deleted Estimate Scenario |
When an existing Estimate Scenario is deleted. |
estimate_scenario:updated |
Updated Estimate Scenario |
When an existing Estimate Scenario is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the scenario. |
account_id |
integer |
The ID of the account that the scenario belongs to. |
budget_in_subunits |
integer |
TThe maximum budget, in the currency's subunits, available for the scenario. |
created_at |
date-time |
When the scenario was created. |
estimate_id |
integer |
The ID of the estimate that is associated with the scenario. |
name |
string |
The name of the scenario. |
rate_card_id |
integer |
The ID of the rate card being used to calculate the resources' rates. |
start_date |
date |
The planned start date of the project. |
updated_at |
date-time |
When the scenario was updated. |
Estimate Scenario Resource
Estimate Scenario Resource |
Events |
Title |
Description |
estimate_scenario_resource:created |
New Estimate Scenario Resource |
When a new Estimate Scenario Resource is created. |
estimate_scenario_resource:updated |
Updated Estimate Scenario Resource |
When an existing Estimate Scenario Resource is updated. |
estimate_scenario_resource:deleted |
Deleted Estimate Scenario Resource |
When an existing Estimate Scenario Resource is deleted. |
Properties |
Type |
Description |
id |
integer |
The ID of the estimate scenario resource. |
account_id |
integer |
The account ID the estimate scenario resource belongs to. |
created_at |
date-time |
When the estimate scenario resource was created. |
estimate_scenario_id |
integer |
The ID of the estimate scenario to which the resource is attached. |
resource_label |
string |
The name of the resource. |
role_id |
integer |
The ID of the role with which the resource will be associated. |
updated_at |
date-time |
When the estimate scenario resource was updated. |
Estimate Scenario Resource - Custom Field Values |
Events |
Title |
Description |
estimate_scenario_resource:custom_field_value_created |
New Custom Field Value for Estimate Scenario Resource |
When a new Custom Field Value is created for an Estimate Scenario Resource. |
estimate_scenario_resource:custom_field_value_deleted |
Deleted Custom Field Value for Estimate Scenario Resource |
When a Custom Field Value is deleted for an Estimate Scenario Resource. |
estimate_scenario_resource:custom_field_value_updated |
Updated Custom Field Value for Estimate Scenario Resource |
When a Custom Field Value is updated for an Estimate Scenario Resource. |
Properties |
Type |
Description |
account_id |
integer |
The ID of the account the custom field belongs to. |
custom_field_id |
integer |
The ID of the custom field the value is associated with. |
custom_field_name |
string |
The name of the custom field the value is associated with. |
custom_field_type |
string |
The type of the custom field the value is associated with. |
custom_field_values |
array |
The value or selected choices for the custom field on the object, in a serialized format. |
value |
string |
The value for the custom field on the object. |
choice_id |
integer |
The ID of the custom field choice selected for the custom field on the object. |
custom_field_value_id |
integer |
The ID of the custom field value. |
created_at |
date-time |
When the custom field value was created. |
display_value |
string |
The value or selected choices for the custom field on the object, in a display friendly format. |
subject_id |
integer |
The ID of the object the custom field value is on. |
subject_type |
string |
The type of the object the custom field value is on. |
updated_at |
date-time |
When the custom field value was updated. |
Expense
Expense |
Events |
Title |
Description |
expense:created |
New Expense |
When a new Expense is created. |
expense:deleted |
Deleted Expense |
When an existing Expense is deleted. |
expense:updated |
Updated Expense |
When an existing Expense is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the expense. |
account_id |
integer |
The ID of the account that the expense belongs to. |
active_invoice_id |
integer |
The ID of the associated, open invoice. |
active_expense_report_id |
integer |
The ID of the pending expense report the expense appears in. |
amount_in_subunits |
integer |
The amount of the expense, in the currency's subunits. |
approved |
boolean |
Whether the expense has been approved. |
category |
string |
The category with which the expense is associated. |
created_at |
date-time |
When the expense was created in Mavenlink. |
currency |
string |
The currency the expense was incurred in. |
date |
date |
When the expense was incurred. |
expense_category_id |
integer |
The ID of the category with which the expense is associated. |
is_billable |
boolean |
Whether the expense is billable to the client. |
notes |
string |
Text added to the expense. |
recent_expense_report_id |
integer |
The ID of the expense report the expense was last added to. |
recent_submission_id |
integer |
The ID of the expense report the expense was last added to. |
role_id |
integer |
The ID of the user's role. |
story_id |
integer |
The ID of the task the expense is associated with. |
taxable |
boolean |
Whether the expense is taxable. |
updated_at |
date-time |
When the expense was updated. |
user_id |
integer |
The ID of the user who created the expense. |
workspace_id |
integer |
The ID of the project the expense is associated with. |
Expense Report
Expense Report |
Events |
Title |
Description |
expense_report:created |
New Expense Report |
When a new Expense Report is created. |
expense_report:updated |
Updated Expense Report |
When an existing Expense Report is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the expense report. |
account_id |
integer |
The ID of the account the expense report belongs to. |
comment |
text |
The description added to the expense report. |
created_at |
date-time |
When the expense report was created. |
creator_id |
integer |
The ID of the user that created the expense report. |
status |
string |
The approval status of the expense report. |
title |
string |
The name of the expense report. |
expense_total_in_subunits |
integer |
The total expensed amount, in the currency's subunits. |
updated_at |
date-time |
When the expense report was updated. |
user_id |
integer |
The ID of the user that expensed the items in the expense report. |
workspace_id |
integer |
The ID of the project the expense report is for. |
Expense Report Expenses |
Events |
Title |
Description |
expense_report:expense_added |
Expense Added to Expense Report |
When an Expense is added to an Expense Report. |
Properties |
Type |
Description |
account_id |
integer |
The ID of the account the expense and expense report belong to. |
created_at |
date-time |
When the expense was added to the expense report |
expense_id |
integer |
The ID of the expense added to the expense report. |
expense_report_id |
integer |
The ID of the expense report. |
Group
Group |
Events |
Title |
Description |
workspace_group:created |
New Group |
When a new Group is created. |
workspace_group:deleted |
Deleted Group |
When an existing Group is deleted. |
workspace_group:updated |
Updated Group |
When an existing Group is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the group. |
account_id |
integer |
The ID of the account the group belongs to. |
address |
string |
The client's address. |
company |
boolean |
Whether the group represents a client. |
contact_name |
string |
The name of the client contact. |
created_at |
date-time |
When the group was created. |
creator_id |
integer |
The ID of the user who created the group. |
email |
string |
The client's email address. |
industry |
string |
The client's industry. |
name |
string |
The client name. |
notes |
string |
Notes added to the group. |
phone_number |
string |
The client's phone number. |
updated_at |
date-time |
When the group was updated. |
website |
string |
The client's website. |
Group - Custom Field Values |
Events |
Title |
Description |
workspace_group:custom_field_value_created |
New Custom Field Value for Group |
When a new Custom Field Value is created for a Group. |
workspace_group:custom_field_value_deleted |
Deleted Custom Field Value for Group |
When a Custom Field Value is deleted for a Group. |
workspace_group:custom_field_value_updated |
Updated Custom Field Value for Group |
When a Custom Field Value is updated for a Group. |
Properties |
Type |
Description |
account_id |
integer |
The ID of the account the custom field belongs to. |
custom_field_id |
integer |
The ID of the custom field the value is associated with. |
custom_field_name |
string |
The name of the custom field the value is associated with. |
custom_field_type |
string |
The type of the custom field the value is associated with. |
custom_field_values |
array |
The value or selected choices for the custom field on the object, in a serialized format. |
value |
string |
The value for the custom field on the object. |
choice_id |
integer |
The ID of the custom field choice selected for the custom field on the object. |
custom_field_value_id |
integer |
The ID of the custom field value. |
created_at |
date-time |
When the custom field value was created. |
display_value |
string |
The value or selected choices for the custom field on the object, in a display friendly format. |
subject_id |
integer |
The ID of the object the custom field value is on. |
subject_type |
string |
The type of the object the custom field value is on. |
updated_at |
date-time |
When the custom field value was updated. |
Project
Project |
Events |
Title |
Description |
workspace:created |
New Project |
When a new Project is created. |
workspace:deleted |
Deleted Project |
When an existing Project is deleted. |
workspace:updated |
Updated Project |
When an existing Project is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the project. |
access |
string |
Whether the project is open or invitation only, and who can join it. |
account_id |
integer |
The ID of the account that the project belongs to. |
amount_paid_in_subunits |
integer |
The amount that has been paid to the project, in subunits. |
archived_at |
date-time |
When the project was archived. |
budget_used_in_subunits |
integer |
The amount of the project budget already burned. |
client_role_name |
string |
The label for the client team. |
change_orders_enabled |
boolean |
Whether approval is required for budget, date, and schedule changes. |
created_at |
date-time |
When the project was created. |
creator_id |
integer |
The ID of the user who created the project. |
currency |
string |
The currency of the project. |
current_budget |
integer |
The project budget. |
description |
string |
The description of the project. |
earliest_story_start_date |
date |
The start date of the earliest task in the project. |
effective_due_date |
date |
When the project is due. |
expenses_in_burn_rate |
boolean |
Whether expenses (and additional items in invoices) created in the project will count against the budget used in the project's burn rate calculation. |
budgeted |
boolean |
Whether the project is budgeted. |
last_story_due_date |
date |
The end date of the task that finishes last in the project. |
consultant_role_name |
string |
The label for the provider team. |
original_budget |
integer |
The budget of the project when it was originally created. |
original_due_date |
date |
The original due date of the project. |
percentage_complete |
integer |
How much of the project is complete. |
primary_client_id |
integer |
The ID of the team lead of the client team. |
primary_consultant_id |
integer |
The ID of the team lead of the provider team. |
rate_card_id |
integer |
The rate card of the project. |
start_date |
date |
The start date of the project. |
status |
string |
The status of the project. |
target_margin |
integer |
The target margin of the project. |
title |
string |
The name of the project. |
updated_at |
date-time |
When the project was updated. |
Project - Custom Field Values |
Events |
Title |
Description |
workspace:custom_field_value_created |
New Custom Field Value for Project |
When a new Custom Field Value is created for a Project. |
workspace:custom_field_value_deleted |
Deleted Custom Field Value for Project |
When a Custom Field Value is deleted for a Project. |
workspace:custom_field_value_updated |
Updated Custom Field Value for Project |
When a Custom Field Value is updated for a Project. |
Properties |
Type |
Description |
account_id |
integer |
The ID of the account the custom field belongs to. |
custom_field_id |
integer |
The ID of the custom field the value is associated with. |
custom_field_name |
string |
The name of the custom field the value is associated with. |
custom_field_type |
string |
The type of the custom field the value is associated with. |
custom_field_values |
array |
The value or selected choices for the custom field on the object, in a serialized format. |
value |
string |
The value for the custom field on the object. |
choice_id |
integer |
The ID of the custom field choice selected for the custom field on the object. |
custom_field_value_id |
integer |
The ID of the custom field value. |
created_at |
date-time |
When the custom field value was created. |
display_value |
string |
The value or selected choices for the custom field on the object, in a display friendly format. |
subject_id |
integer |
The ID of the object the custom field value is on. |
subject_type |
string |
The type of the object the custom field value is on. |
updated_at |
date-time |
When the custom field value was updated. |
Project Allocation
Project Allocation |
Events |
Title |
Description |
workspace_allocation:created |
New Project Allocation |
When a new Project Allocation is created. |
workspace_allocation:deleted |
Deleted Project Allocation |
When an existing Project Allocation is deleted. |
workspace_allocation:updated |
Updated Project Allocation |
When an existing Project Allocation is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the project allocation. |
account_id |
integer |
The account ID the project allocation belongs to. |
created_at |
date-time |
When the project allocation was created. |
creator_id |
integer |
The ID of the user who created the allocation. |
end_date |
date |
The date the allocation ends. |
hard |
boolean |
Whether the allocation is hard (true) or soft (false). |
minutes |
integer |
Total time the resource is allocated over the date range, in minutes. |
notes |
string |
User-entered notes about the allocation. |
resource_id |
integer |
The ID of the project resource that the allocation will be associated with. |
start_date |
date |
The date the allocation starts. |
updated_at |
date-time |
When the allocation was updated. |
updater_id |
integer |
The ID of the user who updated the allocation. |
Project Approver
Project Approver |
Events |
Title |
Description |
workspace_approver:created |
New Project Approver |
When a new Project Approver is created. |
workspace_approver:updated |
Updated Project Approver |
When an existing Project Approver is updated. |
workspace_approver:deleted |
Deleted Project Approver |
When an existing Project Approver is deleted. |
Properties |
Type |
Description |
id |
integer |
The ID of the project approver record. |
account_id |
integer |
The ID of the account the project approver belongs to. |
approver_id |
integer |
The user ID of the project approver. |
created_at |
date-time |
When the project approver was created. |
updated_at |
date-time |
When the project approver was updated. |
workspace_id |
integer |
The ID of the project the approver belongs to. |
Project Invitation
Project Invitation |
Events |
Title |
Description |
workspace_invitation:created |
New Project Invitation |
When a new Project Invitation is created. |
workspace_invitation:deleted |
Deleted Project Invitation |
When an existing Project Invitation is deleted. |
workspace_invitation:updated |
Updated Project Invitation |
When an existing Project Invitation is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the project invitation. |
account_id |
integer |
The ID of the account the project invitation belongs to. |
created_at |
date-time |
When the project invitation was sent. |
email_address |
string |
The email address of the invited user. |
email_subject |
string |
The subject line of the invitation email. |
full_name |
string |
The name of the invited user. |
invitee_id |
integer |
The ID of the invited user. |
invitee_team |
string |
The name of the team the invited user was invited to, client ("buyer") or provider ("maven"). |
inviter_id |
integer |
The ID of the user who sent the invitation. |
message |
string |
The text of the invitation email. |
pending |
boolean |
Whether the invitation is pending. |
updated_at |
date-time |
When the project invitation was updated. |
workspace_id |
integer |
The ID of the project the user was invited to. |
Project Participant
Project Participant |
Events |
Title |
Description |
participation:created |
New Project Participant |
When a new Project Participant is added. |
participation:deleted |
Deleted Project Participant |
When an existing Project Participant is deleted. |
participation:updated |
Updated Project Participant |
When an existing Project Participant is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the project participation. |
access_level |
integer |
The participant's project permission level. |
account_id |
integer |
The ID of the account that the participation belongs to. |
bill_rate_in_subunits |
integer |
The participant's bill rate, in the currency's subunits. |
can_edit |
boolean |
Whether the participant can edit the project. |
can_post |
boolean |
Whether the participant can post to the Activity Feed. |
can_edit_expense |
boolean |
Whether the participant can edit expenses in the project. |
can_edit_time |
boolean |
Whether the participant can track time in the project. |
can_invite |
boolean |
Whether the participant can invite other users into the project. |
cost_rate_in_subunits |
integer |
The project participant's cost rate, in the currency's subunits. |
created_at |
date-time |
When the project participation was created. |
is_read_only |
boolean |
Whether the participant has view only access in the project. |
is_team_lead |
boolean |
Whether the participant is the team lead of the project. |
role_id |
integer |
The user's role in the project. |
team |
string |
Whether the participant is a client ("buyer") or provider ("maven") in the project. |
updated_at |
date-time |
When the project participation was last updated. |
user_id |
integer |
The ID of the user that is participating in the project. |
workspace_id |
integer |
The ID of the project the participation is for. |
Project Resource
Project Resource |
Events |
Title |
Description |
workspace_resource:created |
New Project Resource |
When a new Project Resource is added. |
workspace_resource:updated |
Updated Project Resource |
When an existing Project Resource is updated. |
workspace_resource:deleted |
Deleted Project Resource |
When an existing Project Resource is deleted. |
Properties |
Type |
Description |
id |
integer |
The ID of the resource. |
account_id |
integer |
The ID of the account that the resource belongs to. |
created_at |
date-time |
When the resource was created. |
resource_label |
string |
The unique label of the resource. |
role_id |
integer |
The ID of the role associated with this resource. |
workspace_id |
integer |
The ID of the project this resource is for. |
updated_at |
date-time |
When the resource was updated. |
user_id |
integer |
The ID of the user associated with this resource. |
Project Resource - Custom Field Values |
Events |
Title |
Description |
workspace_resource:custom_field_value_created |
New Custom Field Value for Project Resource |
When a new Custom Field Value is created for a Project Resource. |
workspace_resource:custom_field_value_deleted |
Deleted Custom Field Value for Project Resource |
When a Custom Field Value is deleted for a Project Resource. |
workspace_resource:custom_field_value_updated |
Updated Custom Field Value for Project Resource |
When a Custom Field Value is updated for a Project Resource. |
Properties |
Type |
Description |
account_id |
integer |
The ID of the account the custom field belongs to. |
custom_field_id |
integer |
The ID of the custom field the value is associated with. |
custom_field_name |
string |
The name of the custom field the value is associated with. |
custom_field_type |
string |
The type of the custom field the value is associated with. |
custom_field_values |
array |
The value or selected choices for the custom field on the object, in a serialized format. |
value |
string |
The value for the custom field on the object. |
choice_id |
integer |
The ID of the custom field choice selected for the custom field on the object. |
custom_field_value_id |
integer |
The ID of the custom field value. |
created_at |
date-time |
When the custom field value was created. |
display_value |
string |
The value or selected choices for the custom field on the object, in a display friendly format. |
subject_id |
integer |
The ID of the object the custom field value is on. |
subject_type |
string |
The type of the object the custom field value is on. |
updated_at |
date-time |
When the custom field value was updated. |
Scheduled Hours
Scheduled Hours |
Events |
Title |
Description |
daily_scheduled_hours:created |
New Scheduled Hours |
When new Scheduled Hours are created. |
daily_scheduled_hours:updated |
Updated Scheduled Hours |
When existing Scheduled Hours are updated. |
daily_scheduled_hours:deleted |
Deleted Scheduled Hours |
When existing Scheduled Hours are deleted. |
Properties |
Type |
Description |
id |
integer |
The ID of the resource scheduled day. |
account_id |
integer |
The ID of the account the resource scheduled day belongs to. |
assignment_id |
integer |
The ID of the task assignment associated with the resource scheduled day. |
bill_amount_in_subunits |
integer |
The bill amount of the resource scheduled day, in subunits. |
bill_rate_in_subunits |
integer |
The bill rate of the resource scheduled day, in subunits. |
cost_amount_in_subunits |
integer |
The cost amount of the resource scheduled day, in subunits. |
cost_rate_in_subunits |
integer |
The cost rate of the resource scheduled day, in subunits. |
created_at |
date-time |
When the resource scheduled day was created. |
current |
boolean |
Whether the associated assignment is active or inactive. |
date |
date |
The date of the resource scheduled day. |
deleted_at |
date-time |
When the resource scheduled day was deleted. |
minutes |
integer |
The time in minutes of the resource scheduled day. |
story_id |
integer |
The ID of the task the resource scheduled day belongs to. |
updated_at |
date-time |
When the resource scheduled day was updated. |
workspace_id |
integer |
The ID of the project the resource scheduled day belongs to. |
Task
Task |
Events |
Title |
Description |
story:created |
New Task |
When a new Task is created. |
story:updated |
Updated Task |
When an existing Task is updated or soft deleted ('deleted_at' field is set). |
story:deleted |
Deleted Task |
When an existing Task is permanently deleted. |
Properties |
Type |
Description |
id |
integer |
The ID of the task. |
account_id |
integer |
The ID of the account that the task belongs to. |
archived |
boolean |
Whether the task is archived. |
billable |
boolean |
Whether the task is billable. |
budget_estimate_in_subunits |
integer |
The estimated task budget, in the currency's subunits. |
budget_used_in_subunits |
integer |
The task used budget, in the currency's subunits. |
created_at |
date-time |
When the task was created. |
creator_id |
integer |
The ID of the user who created the task. |
deleted_at |
date-time |
When the task was deleted. |
description |
string |
The description of the task. |
due_date |
date |
When the task is due. |
fixed_fee |
boolean |
Whether the task is fixed fee. |
parent_id |
integer |
The ID of the task's parent task. |
percentage_complete |
integer |
The completion percent of the task. |
position |
integer |
The task's position, an internal value used by the Task Tracker. |
priority |
integer |
The priority of the task. |
start_date |
date |
The start date of the task. |
state |
string |
The status of the task. |
story_type |
string |
The type of the task. |
time_estimate_in_minutes |
integer |
The estimated time of the task, in minutes. |
time_trackable |
boolean |
Whether time can be tracked for this task. |
title |
string |
The title of the task. |
updated_at |
date-time |
When the task was last updated. |
weight |
integer |
The weight of the task. (Only milestone tasks can have a weight) |
workspace_id |
integer |
The ID of the project the task is in. |
Task - Custom Field Values |
Events |
Title |
Description |
story:custom_field_value_created |
New Custom Field Value for Task |
When a new Custom Field Value is created for a Task. |
story:custom_field_value_deleted |
Deleted Custom Field Value for Task |
When a Custom Field Value is deleted for a Task. |
story:custom_field_value_updated |
Updated Custom Field Value for Task |
When a Custom Field Value is updated for a Task. |
Properties |
Type |
Description |
account_id |
integer |
The ID of the account the custom field belongs to. |
custom_field_id |
integer |
The ID of the custom field the value is associated with. |
custom_field_name |
string |
The name of the custom field the value is associated with. |
custom_field_type |
string |
The type of the custom field the value is associated with. |
custom_field_values |
array |
The value or selected choices for the custom field on the object, in a serialized format. |
value |
string |
The value for the custom field on the object. |
choice_id |
integer |
The ID of the custom field choice selected for the custom field on the object. |
custom_field_value_id |
integer |
The ID of the custom field value. |
created_at |
date-time |
When the custom field value was created. |
display_value |
string |
The value or selected choices for the custom field on the object, in a display friendly format. |
subject_id |
integer |
The ID of the object the custom field value is on. |
subject_type |
string |
The type of the object the custom field value is on. |
updated_at |
date-time |
When the custom field value was updated. |
Task Assignment
Task Assignment |
Events |
Title |
Description |
assignment:created |
New Task Assignment |
When a new Task Assignment is created. |
assignment:deleted |
Deleted Task Assignment |
When an existing Task Assignment is deleted. |
assignment:updated |
Updated Task Assignment |
When an existing Task Assignment is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the assignment. |
account_id |
integer |
The ID of the account that the assignment belongs to. |
allocated_budget_in_subunits |
integer |
The allocated budget, calculated automatically based on the sum of all allocated hours and resource rate. |
allocated_minutes |
integer |
How much time the resource has been allocated to work on this task. |
assignee_id |
integer |
The ID of the user the assignment is for. |
assigner_id |
integer |
The ID of the user who created the assignment. |
created_at |
date-time |
When the assignment was created. |
current |
boolean |
Whether the assignment is active or inactive. |
estimated_minutes |
integer |
The number of minutes the resource is estimated to work on the task. |
resource_id |
integer |
The ID of the resource the assignment is for. |
story_id |
integer |
The ID of the task. |
updated_at |
date-time |
When the assignment was updated. |
Time Entry
Time Entry |
Events |
Title |
Description |
time_entry:created |
New Time Entry |
When a new Time Entry is created. |
time_entry:updated |
Updated Time Entry |
When an existing Time Entry is updated. |
time_entry:deleted |
Deleted Time Entry |
When an existing Time Entry is deleted. |
Properties |
Type |
Description |
id |
integer |
The ID of the time entry. |
account_id |
integer |
The ID of the account the time entry belongs to. |
active_timesheet_id |
integer |
The ID of the pending timesheet the time entry appears in. |
amount_in_subunits |
integer |
The billable amount for the time entry, in the currency's subunits. |
approved |
boolean |
Whether the time entry has been approved. |
billable |
boolean |
Whether this time entry is billable time. |
created_at |
date-time |
When the time entry was created. |
currency |
string |
The currency the time entry is being billed in. |
date |
date |
The date the activity for which the time is being entered was performed. |
notes |
string |
Notes added to the time entry. |
recent_timesheet_id |
integer |
The ID of the timesheet the time entry was last added to. |
story_id |
integer |
The ID of the task the time entry is logging work for. |
time |
integer |
The amount of time in minutes that the activity was worked on. |
updated_at |
date-time |
When the time entry was updated. |
user_id |
integer |
The ID of the user who created the time entry. |
workspace_id |
integer |
The ID of the project the time entry is logging work in. |
Timesheet
Timesheet |
Events |
Title |
Description |
timesheet:created |
New Timesheet |
When a new Timesheet is created. |
timesheet:updated |
Updated Timesheet |
When an existing Timesheet is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the timesheet. |
account_id |
integer |
The ID of the account the timesheet belongs to. |
bill_amount_in_subunits |
integer |
The total billable amount of the timesheet. |
comment |
text |
Notes added to the timesheet. |
created_at |
date-time |
When the timesheet was created. |
creator_id |
integer |
The ID of the user who created the timesheet. |
end_date |
date |
The end date of the timesheet. |
start_date |
date |
The start date of the timesheet. |
status |
string |
The approval status of the timesheet. |
title |
string |
The title of the timesheet. |
updated_at |
date-time |
When the timesheet was updated. |
user_id |
integer |
The ID of the user who completed the work the timesheet logs. |
workspace_id |
integer |
The ID of the project the timesheet is for. |
Timesheet Time Entries |
Events |
Title |
Description |
timesheet:time_entry_added |
Time Entry Added to Timesheet |
When a Time Entry is added to a Timesheet. |
Properties |
Type |
Description |
account_id |
integer |
The ID of the account the timesheet and time entry belong to. |
created_at |
date-time |
When the time entry was added to the timesheet. |
time_entry_id |
integer |
The ID of the time entry added to the timesheet. |
timesheet_id |
integer |
The ID of the timesheet. |
User
User |
Events |
Title |
Description |
user:created |
New User |
When a new User is created. |
user:deleted |
Deleted User |
When an existing User is deleted. |
user:updated |
Updated User |
When an existing User is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the user. |
abbreviated_timezone |
string |
The user's time zone. |
account_id |
integer |
The account ID the user belongs to. |
city |
string |
The user's city. |
company_name |
string |
The user's company. |
country |
string |
The user's country. |
created_at |
date-time |
When the user was created. |
full_name |
string |
The user's full name. |
headline |
string |
The user's headline or title. |
photo_path |
string |
The URL of the user's photo. |
state |
string |
The user's state. |
updated_at |
date-time |
When the user was updated. |
website |
string |
The user's website. |
User - Custom Field Values |
Events |
Title |
Description |
user:custom_field_value_created |
New Custom Field Value for User |
When a new Custom Field Value is created for a User. |
user:custom_field_value_deleted |
Deleted Custom Field Value for User |
When a Custom Field Value is deleted for a User. |
user:custom_field_value_updated |
Updated Custom Field Value for User |
When a Custom Field Value is updated for a User. |
Properties |
Type |
Description |
account_id |
integer |
The ID of the account the custom field belongs to. |
custom_field_id |
integer |
The ID of the custom field the value is associated with. |
custom_field_name |
string |
The name of the custom field the value is associated with. |
custom_field_type |
string |
The type of the custom field the value is associated with. |
custom_field_values |
array |
The value or selected choices for the custom field on the object, in a serialized format. |
value |
string |
The value for the custom field on the object. |
choice_id |
integer |
The ID of the custom field choice selected for the custom field on the object. |
custom_field_value_id |
integer |
The ID of the custom field value. |
created_at |
date-time |
When the custom field value was created. |
display_value |
string |
The value or selected choices for the custom field on the object, in a display friendly format. |
subject_id |
integer |
The ID of the object the custom field value is on. |
subject_type |
string |
The type of the object the custom field value is on. |
updated_at |
date-time |
When the custom field value was updated. |
User Skill
User Skill |
Events |
Title |
Description |
skill_membership:created |
New User Skill |
When a skill is added for a user. |
skill_membership:deleted |
Deleted User Skill |
When a skill is removed from a user. |
skill_membership:updated |
Updated User Skill |
When a user's skill is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the user skill. |
account_id |
integer |
The ID of the account the user skill belongs to. |
created_at |
date-time |
When the user skill was created. |
creator_id |
integer |
The ID of the user who assigned the skill to the user. |
level |
integer |
The user's proficiency level for the skill. |
skill_id |
integer |
The ID of the account skill. |
updated_at |
date-time |
When the user skill was updated. |
user_id |
integer |
The ID of the user the skill belongs to. |
Vendor
Vendor |
Events |
Title |
Description |
vendor:created |
New Vendor |
When a new Vendor is created. |
vendor:deleted |
Deleted Vendor |
When an existing Vendor is deleted. |
vendor:updated |
Updated Vendor |
When an existing Vendor is updated. |
Properties |
Type |
Description |
id |
integer |
The ID of the vendor. |
account_id |
integer |
The ID of the account the vendor belongs to. |
archived_at |
date-time |
When the vendor was archived. |
created_at |
date-time |
When the vendor was created. |
name |
string |
The name of the vendor. |
updated_at |
date-time |
When the vendor was updated. |