Subscribed Events is an API feature that records up to 9 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
Subscribed Events is a feature that records trackable changes in your account. You can access the last 9 days of changes using the Subscribed Events API. 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.
In addition to the API, Enterprise and Premier accounts can access the following features in the app:
- The Recent History table within Settings (For Account Administrators only)
- The Project History page in projects (For Project Administrators and Account Administrators only)
By default, Recent History and Project History display 120 days of activity, but with the Extended History add-on—now in beta—you can keep events for longer. Extended History enables you to see all the activity that occurred over the entirety of a project or check what happened in your account months ago. For more information, please contact Customer Success.
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 Default Task Status Set
Account Default Task Status Set | ||
---|---|---|
Events | Title | Description |
default_task_status_set:created |
Account Default Task Status Set Created | When the account default task status set is first set. |
default_task_status_set:updated |
Account Default Task Status Set Changed | When the account default task status set is changed. |
Properties | Type | Description |
id |
integer | The ID of the account default setting. |
account_id |
integer | The ID of the account the task status set belongs to. |
created_at |
date-time | When the account default task status set was first set. |
task_status_set_id |
integer | The ID of the task status set that is the default for the account. |
updated_at |
date-time | When the account default task status set 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 Kantata OX. |
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. |
Budget Change Order
Budget Change Order | ||
---|---|---|
Events | Title | Description |
budget_change_order:created |
New Budget Change Order | When a new Budget Change Order is created. |
budget_change_order:deleted |
Deleted Budget Change Order | When an existing Budget Change Order is deleted. |
budget_change_order:updated |
Updated Budget Change Order | When an existing Budget Change Order is updated. |
Properties | Type | Description |
id |
integer | The ID of the budget change order. |
account_id |
integer | The account ID of the project the budget change order is associated with. |
created_at |
date-time | When the budget change order was created. |
creator_id |
integer | The ID of the user who created the budget change order. |
description |
text | The message added to the budget change order. |
budget_change_in_base_units |
integer | The amount of the budget change order, in the project currency's base units. This is the change in budget, not the new total budget. |
status |
string | The status of the budget change order (e.g. new, accepted, declined, or cancelled). |
updated_at |
date-time | When the budget change order was updated. |
workspace_id |
integer | The ID of the project the budget change order is associated with. |
Cost Rate
Cost Rate | ||
---|---|---|
Events | Title | Description |
cost_rate:created |
New Cost Rate | When a new Cost Rate is created. |
cost_rate:updated |
Updated Cost Rate | When an existing Cost Rate is updated. |
cost_rate:deleted |
Deleted Cost Rate | When an existing Cost Rate is deleted. |
Properties | Type | Description |
id |
integer | The ID of the cost rate. |
account_id |
integer | The ID of the account the cost rate belongs to. |
account_membership_id |
integer | The ID of the account membership this cost rate is associated with. |
amount_in_subunits |
integer | The amount of the cost rate, in the currency's subunits. |
created_at |
date-time | When the cost rate was created. |
currency |
string | The currency of the cost rate. |
updated_at |
date-time | When the cost rate was updated. |
Custom Field
Custom Field | ||
---|---|---|
Events | Title | Description |
custom_field:created |
New Custom Field | When a new Custom Field is created. |
custom_field:updated |
Updated Custom Field | When an existing Custom Field is updated. |
custom_field:deleted |
Deleted Custom Field | When an existing Custom Field is deleted. |
Properties | Type | Description |
id |
integer | The ID of the custom field. |
account_id |
integer | The ID of the account the custom field belongs to. |
available_in_estimates |
boolean | Whether the custom field is available for legacy estimates. |
available_to_resources |
boolean | Whether the custom field appears in the resource side panel. |
created_at |
date-time | When the custom field was created. |
creator_id |
integer | The ID of the user that created the custom field. |
choices |
array | The choices of the custom field (for single and multiple choice custom fields). |
id |
integer | The ID of the custom field choice. |
label |
string | The label for the custom field choice. |
position |
integer | The position of the custom field choice in the list of available choices. |
custom_field_set_id |
integer | The ID of the set the custom field belongs to. |
hidden_in_user_interface |
boolean | Whether the custom field is hidden in certain areas of the user interface. |
name |
string | The name of the custom field. |
placeholder_text |
string | Placeholder text for the custom field. |
read_permission |
integer | The account-level permission that can see the custom field. |
subject_type |
string | The type of object the custom field is for (e.g. Story [task], User , Workspace [project], or WorkspaceGroup [group]). |
unique_value_required |
boolean | Whether unique values are required for the custom field. |
updated_at |
date-time | When the custom field was updated. |
value_type |
string | The format of the custom field's value (e.g. string, date, number, currency, multi, or single). |
write_permission |
integer | The account-level permission that can edit the custom field. |
Custom Field Set
Custom Field Set | ||
---|---|---|
Events | Title | Description |
custom_field_set:created |
New Custom Field Set | When a new Custom Field Set is created. |
custom_field_set:updated |
Updated Custom Field Set | When an existing Custom Field Set is updated. |
custom_field_set:deleted |
Deleted Custom Field Set | When an existing Custom Field Set is deleted. |
Properties | Type | Description |
id |
integer | The ID of the custom field set. |
account_id |
integer | The ID of the account the custom field set belongs to. |
created_at |
date-time | When the custom field set was created. |
creator_id |
integer | The ID of the user that created the custom field set. |
name |
string | The name of the custom field set. |
subject_type |
string | The type of object the custom field set is for (e.g. Story [task], User , Workspace [project], or WorkspaceGroup [group]). |
updated_at |
date-time | When the custom field set was updated. |
Custom Task Status
Custom Task Status | ||
---|---|---|
Events | Title | Description |
custom_task_status:created |
New Custom Task Status | When a new Custom Task Status is created. |
custom_task_status:deleted |
Deleted Custom Task Status | When an existing Custom Task Status is deleted. |
custom_task_status:updated |
Updated Custom Task Status | When an existing Custom Task Status is updated. |
Properties | Type | Description |
id |
integer | The ID of the custom task status. |
account_id |
integer | The ID of the account the custom task status belongs to. |
created_at |
date-time | When the custom task status was created. |
name |
string | The name of the custom task status. |
status_type |
string | The type of the custom task status (e.g. not started, started, needs info, complete). |
task_status_set_id |
integer | The ID of the task status set the custom task status belongs to. |
updated_at |
date-time | When the custom task status 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 object the custom field is for (e.g. Estimate , Story [task], User , Workspace [project], or WorkspaceGroup [group]). |
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 object the custom field is for (e.g. Estimate , Story [task], User , Workspace [project], or WorkspaceGroup [group]). |
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 Kantata OX. |
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 Budget
Expense Budget | ||
---|---|---|
Events | Title | Description |
expense_budget:created |
New Expense Budget | When a new Expense Budget is created. |
expense_budget:deleted |
Deleted Expense Budget | When an existing Expense Budget is deleted. |
expense_budget:updated |
Updated Expense Budget | When an existing Expense Budget is updated. |
Properties | Type | Description |
id |
integer | The ID of the expense budget. |
account_id |
integer | The ID of the account the expense budget belongs to. |
billable |
boolean | Whether the expense budget is billable. |
cost_per_unit_in_subunits |
integer | The cost, in the subunits of the currency (e.g. cents for USD). |
created_at |
date-time | When the expense budget was created. |
creator_id |
integer | The ID of the user that created the expense budget. |
description |
string | The description of the expense budget. |
expected_by |
date | When the expenses are expected to be logged by. |
fixed_fee |
boolean | Whether the expense budget is fixed fee. |
impacts_margin |
boolean | Whether the expense budget impacts the project margin. |
markup_per_unit_in_subunits |
integer | The markup, in the subunits of the currency (e.g. cents for USD). |
markup_percentage |
float | The markup percentage. |
markup_type |
string | The markup type - flat fee or percentage. |
name |
string | The name of the expense budget. |
quantity |
integer | The number of units expected for this expense budget. |
story_id |
integer | The ID of the associated task, if any. |
updated_at |
date-time | When the expense budget was updated. |
workspace_id |
integer | The ID of the project the expense budget is for. |
Expense Budget Expenses | ||
Events | Title | Description |
expense_budget:expense_added |
Expense Added to Expense Budget | When an Expense is added to an Expense Budget. |
expense_budget:expense_removed |
Expense Removed from Expense Budget | When an Expense is removed from an Expense Budget. |
Properties | Type | Description |
account_id |
integer | The ID of the account the expense and the expense budget belong to. |
expense_budget_id |
integer | The ID of the expense budget. |
expense_id |
integer | The ID of the expense associated to the expense budget. |
Expense Budget Fixed Fee Items | ||
Events | Title | Description |
expense_budget:fixed_fee_item_added |
Fixed Fee Item for Expense Budget Added to Invoice | When a Fixed Fee Item for an Expense Budget is added to an Invoice. |
expense_budget:fixed_fee_item_removed |
Fixed Fee Item for Expense Budget Removed from Invoice | When a Fixed Fee Item for an Expense Budget is removed from an Invoice. |
Properties | Type | Description |
account_id |
integer | The ID of the account the fixed fee item and the expense budget belong to. |
expense_budget_id |
integer | The ID of the expense budget. |
fixed_fee_item_id |
integer | The ID of the fixed fee item associated to the expense budget. |
invoice_id |
integer | The ID of the invoice the fixed fee item is on. |
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 object the custom field is for (e.g. Estimate , Story [task], User , Workspace [project], or WorkspaceGroup [group]). |
updated_at |
date-time | When the custom field value was updated. |
Invoice
Invoice | ||
---|---|---|
Events | Title | Description |
invoice:created |
New Invoice | When a new Invoice is created. |
invoice:deleted |
Deleted Invoice | When an existing Invoice is deleted. |
invoice:updated |
Updated Invoice | When an existing Invoice is updated (does not include when charges are added to an invoice). |
Properties | Type | Description |
id |
integer | The ID of the invoice. |
account_id |
integer | The ID of the account the user who sent the invoice belongs to. |
created_at |
date-time | When the invoice was created. |
currency |
string | The currency being used for the invoice. |
draft |
boolean | Whether or not the invoice is a draft. |
invoice_date |
date | The date the invoice was incurred. |
invoice_number |
integer | The invoice number (may be user-defined). |
invoice_title |
string | The title of the invoice title (user-defined). |
message |
text | Notes added to the invoice. |
payment_schedule |
integer | The number of days within which the total amount of the invoice is expected to be paid. |
project_code |
string | The invoice project code (user-defined). |
purchase_order |
string | The invoice purchase order (user-defined). |
recipient_id |
integer | The user ID of the invoice recipient (i.e. the client team lead when the invoice was created). |
show_time_entry_creators |
boolean | Whether the names of people who tracked time are included in the invoice. |
show_time_entry_dates |
boolean | Whether time entry dates are included in the invoice. |
show_expense_dates |
boolean | Whether expense dates are included in the invoice. |
show_expense_item_prefix_in_quickbooks |
boolean | Whether prefixes are used in expense descriptions within QuickBooks to identify and separate the various parts of the description. |
show_expense_notes |
boolean | Whether expense notes are included in the invoice. |
show_time_entry_hours |
boolean | Whether time entry hours are included in the invoice. |
show_time_entry_notes |
boolean | Whether time entry notes are included in the invoice. |
show_project_names_for_time_entries_in_quickbooks |
boolean | Whether project names are used in time entry roll-up for QuickBooks invoices. |
show_time_entry_rates |
boolean | Whether time entry rates are included in the invoice. |
show_time_entry_roles |
boolean | Whether time entry roles are included in the invoice. |
show_time_entry_subtotals |
boolean | Whether time entry subtotals are included in the invoice. |
show_task_names |
boolean | Whether task names are included in the invoice. |
show_time_entry_tax |
boolean | Whether time entry taxes are included in the invoice. |
show_time_adjustments |
boolean | Whether time adjustments are included in the invoice. |
show_time_entry_item_prefix_in_quickbooks |
boolean | Whether prefixes are used in time entry descriptions within QuickBooks to identify and separate the various parts of the description. |
show_project_names_for_expenses_in_quickbooks |
boolean | Whether project names are used in expense roll-up for QuickBooks invoices. |
status |
string | The current status of the invoice ('new', 'cancelled', 'accepted payment'). |
tax_rate |
decimal | The tax rate percentage that is applied to the invoice total. |
updated_at |
date-time | When the invoice was updated. |
user_id |
integer | The ID of the user who created the invoice. |
Organization
Organization | ||
---|---|---|
Events | Title | Description |
organization:created |
New Organization | When a new Organization is created. |
organization:updated |
Updated Organization | When an existing Organization is updated. |
organization:deleted |
Deleted Organization | When an existing Organization is deleted. |
Properties | Type | Description |
id |
integer | The ID of the organization. |
account_id |
integer | The ID of the account that the organization belongs to. |
created_at |
date-time | When the organization was created. |
name |
string | The name of the organization. |
parent_id |
integer | The ID of the parent organization. |
type |
string | The type of the organization. ('Geography' or 'Department') |
updated_at |
date-time | When the organization was updated. |
Organization Membership
Organization Membership | ||
---|---|---|
Events | Title | Description |
organization_membership:created |
Organization Applied | When an organization is applied to an object. |
organization_membership:updated |
Organization Updated for Object | When the organization of an object is updated. |
organization_membership:deleted |
Organization Removed | When an organization is removed from an object. |
Properties | Type | Description |
id |
integer | The ID of the organization membership. |
account_id |
integer | The ID of the account that the organization membership belongs to. |
created_at |
date-time | When the organization membership was created. |
department_id |
integer | The ID of the associated department. |
geography_id |
integer | The ID of the associated geography. |
member_id |
integer | The ID of the object the organization membership is for. |
member_type |
string | The type of object that the organization membership is for. (Custom Field Set, Resource (from either a project or an estimate scenario), User, or Workspace (i.e. project).) |
primary |
boolean | Whether the organization membership is the primary organization for the associated object. |
updated_at |
date-time | When the organization membership 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. |
exclude_archived_stories_percent_complete |
bool | Whether archived tasks are excluded from the project percentage complete calculation. |
expenses_in_burn_rate |
boolean | Whether expenses and additional invoice items count against the budget used in the project's actual fees calculation. |
actual_fees_includes_additional_line_items |
boolean | Whether additional items on invoices for the project count against the budget used in the project's actual fees calculation. |
actual_fees_includes_expenses |
boolean | Whether expenses created in the project count against the budget used in the project's actual fees 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. |
posts_require_privacy_decision |
bool | Whether posts are private (true) or shared with all participants (false) by default. |
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. |
require_expense_approvals |
bool | Whether expense approvals are required in the project. |
require_time_approvals |
bool | Whether time approvals are required in the project. |
show_nonbillable_time_on_invoices |
bool | Whether invoices for the project can include non-billable time. |
stage |
string | The stage of the project ('estimate' or 'project'). |
start_date |
date | The start date of the project. |
stories_are_fixed_fee_by_default |
bool | Whether tasks on the project are set as fixed fee (true) or time and materials (false) by default. |
status |
string | The status of the project. |
target_margin |
integer | The target margin of the project. |
tasks_default_non_billable |
bool | Whether tasks in the project default to billable (false) or non-billable (true). |
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 object the custom field is for (e.g. Estimate , Story [task], User , Workspace [project], or WorkspaceGroup [group]). |
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 Permissions
Project Permissions | ||
---|---|---|
Events | Title | Description |
project_permission:created |
Added Project Permissions | When a project permission is added for a user. (Note: Some project permissions are tracked on the Project Participant object.) |
project_permission:deleted |
Removed Project Permissions | When a project permission is removed for a user. |
Properties | Type | Description |
id |
integer | The ID of the project permission. |
account_id |
integer | The ID of the account the project permission belongs to. |
created_at |
date-time | When the project permission was added for the user. |
permission |
string | The project permission. |
user_id |
integer | The ID of the user the project permission is for. |
workspace_id |
integer | The ID of the project the permission 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 object the custom field is for (e.g. Estimate , Story [task], User , Workspace [project], or WorkspaceGroup [group]). |
updated_at |
date-time | When the custom field value was updated. |
Schedule Change Order
Schedule Change Order | ||
---|---|---|
Events | Title | Description |
schedule_change_order:created |
New Schedule Change Order | When a new Schedule Change Order is created. |
schedule_change_order:deleted |
Deleted Schedule Change Order | When an existing Schedule Change Order is deleted. |
schedule_change_order:updated |
Updated Schedule Change Order | When an existing Schedule Change Order is updated. |
Properties | Type | Description |
id |
integer | The ID of the schedule change order. |
account_id |
integer | The account ID of the project the schedule change order is associated with. |
created_at |
date-time | When the schedule change order was created. |
creator_id |
integer | The ID of the user who created the schedule change order. |
description |
string | The message added to the schedule change order. |
due_date |
date | The proposed new due date. |
status |
string | The status of the schedule change order (e.g. new, accepted, declined, or cancelled). |
updated_at |
date-time | When the change order was updated. |
workspace_id |
integer | The ID of the project the schedule change order is associated with. |
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 or soft deleted ('deleted_at' field is set). |
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 object the custom field is for (e.g. Estimate , Story [task], User , Workspace [project], or WorkspaceGroup [group]). |
updated_at |
date-time | When the custom field value was updated. |
Task - Status | ||
Events | Title | Description |
story:status_selected |
Task Status Selected | When a status is selected for a task or To Do. |
Properties | Type | Description |
account_id |
integer | The ID of the account the task belongs to. |
created_at |
date-time | When the task status was updated. |
status |
string | The name of the task status. |
story_id |
integer | The ID of the task or To Do this status is set on. |
story_status_set_option_id |
integer | The ID of the custom task status. |
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. |
Task Status Set
Task Status Set | ||
---|---|---|
Events | Title | Description |
task_status_set:created |
New Task Status Set | When a new Task Status Set is created. |
task_status_set:deleted |
Deleted Task Status Set | When an existing Task Status Set is deleted. |
task_status_set:updated |
Updated Task Status Set | When an existing Task Status Set is updated. |
Properties | Type | Description |
id |
integer | The ID of the task status set. |
account_id |
integer | The ID of the account the task status set belongs to. |
created_at |
date-time | When the task status set was created. |
name |
string | The name of the task status set. |
updated_at |
date-time | When the task status set was updated. |
Task Status Set of Project
Task Status Set of Project | ||
---|---|---|
Events | Title | Description |
workspace_task_status_set:created |
New Task Status Set of Project | When a task status set is assigned to a project. |
workspace_task_status_set:deleted |
Deleted Task Status Set of Project | When a task status set is removed from a project. |
workspace_task_status_set:updated |
Updated Task Status Set of Project | When a task status set is changed for a project. |
Properties | Type | Description |
id |
integer | The ID of the project task status set setting. |
account_id |
integer | The ID of the account the project belongs to. |
created_at |
date-time | When the task status set was first applied to the project. |
task_status_set_id |
integer | The ID of the associated task status set. |
updated_at |
date-time | When the project's task status set was changed. |
workspace_id |
integer | The ID of the associated project. |
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. |
Time Lock
Time Lock | ||
---|---|---|
Events | Title | Description |
line_item_lock:created |
New Time Lock | When a new Time Lock is created. |
Properties | Type | Description |
id |
integer | The ID of the line item lock (i.e. time lock). |
account_id |
integer | The ID of the account for which time entries are locked. |
created_at |
date-time | When the line item lock (i.e. time lock) was created. |
creator_id |
integer | The ID of the user that locked time entries. |
locked_to |
date | The date before which no one on the account is able to submit or edit time entries. |
Time Off Entry
Time Off Entry | ||
---|---|---|
Events | Title | Description |
time_off_entry:created |
New Time Off Entry | When a new Time Off Entry is created. |
time_off_entry:deleted |
Deleted Time Off Entry | When an existing Time Off Entry is deleted. |
time_off_entry:updated |
Updated Time Off Entry | When an existing Time Off Entry is updated. |
Properties | Type | Description |
id |
integer | The ID of the time off entry. |
account_id |
integer | The ID of the account the time off entry belongs to. |
created_at |
date-time | When the time off entry was created. |
hours |
float | Total time off, in hours. |
requested_date |
date | When the time off is for. |
submission_date |
date | When the time off entry was submitted. |
updated_at |
date-time | When the time off entry was updated. |
user_id |
integer | The ID of the user the time off is for. |
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 object the custom field is for (e.g. Estimate , Story [task], User , Workspace [project], or WorkspaceGroup [group]). |
updated_at |
date-time | When the custom field value was updated. |
User Email Address
User Email Address | ||
---|---|---|
Events | Title | Description |
email_address:created |
New User Email Address | When a new User Email Address is created. |
email_address:updated |
Updated User Email Address | When an existing User Email Address is updated. |
email_address:deleted |
Deleted User Email Address | When an existing User Email Address is deleted. |
Properties | Type | Description |
id |
integer | The ID of the email address. |
account_id |
integer | The ID of the account the associated user belongs to. |
email_address |
string | The email address. |
created_at |
date-time | When the email address was created. |
google_account |
boolean | Whether the email address is used for Google single sign-on. |
primary |
boolean | Whether this is the user's primary email address. |
updated_at |
date-time | When the email address was updated. |
user_id |
integer | The ID of the user the email address belongs to. |
verified |
boolean | Whether the email address has been verified. |
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. |
User Workweek
User Workweek | ||
---|---|---|
Events | Title | Description |
workweek_membership:created |
New User Workweek | When a new Workweek is applied to a user. |
workweek_membership:deleted |
Deleted User Workweek | When an existing Workweek for a user is deleted. |
workweek_membership:updated |
Updated User Workweek | When an existing Workweek for a user is updated. |
Properties | Type | Description |
id |
integer | The ID of the workweek membership. |
account_id |
integer | The ID of the account the workweek membership belongs to. |
created_at |
date-time | When the workweek was applied to a user. |
start_date |
date | The start date of the workweek. (Only populated for custom workweeks.) |
updated_at |
date-time | When the workweek membership was updated. |
user_id |
integer | The ID of the user the workweek belongs to. |
workweek_id |
integer | The ID of the associated workweek. |
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. |
Workweek
Workweek | ||
---|---|---|
Events | Title | Description |
workweek:created |
New Workweek | When a new Workweek is created. |
workweek:deleted |
Deleted Workweek | When an existing Workweek is deleted. |
workweek:updated |
Updated Workweek | When an existing Workweek is updated. |
Properties | Type | Description |
id |
integer | The ID of the workweek. |
account_id |
integer | The ID of the account that the workweek belongs to. |
created_at |
date-time | When the workweek was created. |
creator_id |
integer | The ID of the user that created the workweek. |
default |
boolean | Whether the workweek is the default workweek for the account. |
friday_minutes |
integer | The number of available working minutes on Friday. |
monday_minutes |
integer | The number of available working minutes on Monday. |
saturday_minutes |
integer | The number of available working minutes on Saturday. |
start_date |
date | The start date of the workweek. |
sunday_minutes |
integer | The number of available working minutes on Sunday. |
thursday_minutes |
integer | The number of available working minutes on Thursday. |
total_minutes |
integer | The total number of available working minutes for the week. |
tuesday_minutes |
integer | The number of available working minutes on Tuesday. |
updated_at |
date-time | When the workweek was updated. |
wednesday_minutes |
integer | The number of available working minutes on Wednesday. |
Comments
0 comments
Please sign in to leave a comment.