Back to Mavenlink.com Blog Tour Status

Subscribed Events Reference (Beta)

 
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.

Note: During the Beta period, it's possible we will record fewer or greater than 7 days of changes.

The following tables provide a quick reference for every type of trackable change (also called an "event"), and for the properties of each event. For descriptions of the properties, refer to parameter descriptions in the API documentation. For properties that don't match a parameter name, descriptions are included here.

Assignment
Event Properties
assignment:created
When someone is assigned to a task.
id  (integer) — The ID of the task.
account_id  (integer) — The ID of the account the task is in.
allocated_budget_in_subunits (integer) — The budget for a task, in cents or another currency subunit.
allocated_minutes (integer) — The time allocated to the task for the day, in minutes.
assignee_id  (integer) — The ID of the user assigned to / unassigned from the task.
assigner_id (integer) — The ID of the user who created or changed the assignment.
created_at  (date-time) — When the task was created.
current  (boolean) — Whether the assignment is active. True indicates an active assignment, and False indicates inactive.
Assignments cannot be deleted, but are considered inactive when a resource is unassigned from a task.
estimated_minutes  (integer) — The number of minutes the resource is estimated to work on the task.
resource_id  (integer) — The ID of the resource assigned to or unassigned from the task.
story_id (integer) — The ID of the task that has been assigned or unassigned.
updated_at  (date-time) — When the task was last updated.
assignment:deleted
When someone is unassigned from a task.
assignment:updated
When a task assignment is updated.

 

Daily Scheduled Hours (Story Allocation Days)
Event Properties
daily_scheduled_hours:created
When someone is allocated hours on a particular day.
id  (integer) — The ID of the scheduled hours for a particular day.
account_id  (integer) — The ID of the account the hours were scheduled in.
assignment_id  (integer) — The ID of the task assignment the scheduled hours are for.
bill_amount_in_subunits  (integer) — The amount that is expected to be billed for someone's scheduled hours.
bill_rate_in_subunits  (integer) — The rate that is expected to be billed for someone's scheduled hours, in cents per hour.
cost_amount_in_subunits  (integer) — The ID of the account the hours were scheduled in.
cost_rate_in_subunits  (integer) — The ID of the account the hours were scheduled in.
created_at  (date-time) — When the hours were scheduled.
current  (boolean) — Whether the allocation is active. True indicates an active allocation, and False indicates inactive.
Allocations cannot be deleted, but are considered inactive when someone's scheduled hours are removed.

date  (date) — The day the hours are scheduled for.
deleted_at  (date-time) — When the hours were deleted.
minutes  (integer) — The number of minutes scheduled.
story_id  (integer) — The ID of the task the hours were scheduled for.
updated_at  (date-time) — When the scheduled hours for a day were last changed.
workspace_id  (integer) — The ID of the project the hours were scheduled in.
daily_scheduled_hours:deleted
When someone's allocated hours are removed.
daily_scheduled_hours:updated
When someone's allocated hours on a particular day have been updated.

 

Custom Field Values
Event Properties
estimate:custom_field_value_created
When a value has been entered for an estimate custom field.
custom_field_id  (integer) — The ID of the custom field.
custom_field_name  (string) — The name of the custom field.
custom_field_type  (string) — The type of custom field (Estimate, Project, Group, Resource, Task, and User).
custom_field_values  (array) — This can be a string, date, number, currency, or single/multi choice value.
custom_field_value_id  (integer) — The ID of the custom field's value.
created_at  (datetime) — When the value was entered.
display_value  (string) — The format the value is in (string, date, number, currency, or single/multi choice). In the API documentation, the property is called value.
subject_id  (integer) — The ID of the Estimate, Project, Group, Resource, Task, or User the custom field is for.
subject_type  (string) — Whether the custom field is for an Estimate, Project, Group, Resource, Task, or User.
updated_at  (date-time) — When the value was last updated.
estimate:custom_field_value_deleted
When a value has been deleted for an estimate custom field.
estimate:custom_field_value_updated
When a value has been updated for an estimate custom field.
estimate_scenario_resource:
custom_field_value_created

When a value has been entered for a resource label's custom field in an estimate scenario.
estimate_scenario_resource:
custom_field_value_deleted

When a value has been deleted for a resource label's custom field in an estimate scenario.
estimate_scenario_resource:
custom_field_value_updated

When a value has been updated for a resource label's custom field in an estimate scenario.
story:custom_field_value_created
When a value has been created for a task custom field.
story:custom_field_value_deleted
When a value has been deleted for a task custom field.
story:custom_field_value_updated
When a value has been updated for a task custom field.
user:custom_field_value_created
When a value has been created for a user custom field.
user:custom_field_value_deleted
When a value has been deleted for a user custom field.
user:custom_field_value_updated
When a value has been updated for a user custom field.
workspace:custom_field_value_created
When a value has been created for a project custom field.
workspace:custom_field_value_deleted
When a value has been deleted for a project custom field.
workspace:custom_field_value_updated
When a value has been created for a project custom field.
workspace_group:
custom_field_value_created

When a value has been created for a project group custom field.
workspace_group:
custom_field_value_deleted

When a value has been deleted for a project group custom field.
workspace_group:
custom_field_value_updated

When a value has been created for a project group custom field.
workspace_resource:
custom_field_value_created

When a value has been created for a project resource custom field.
workspace_resource:
custom_field_value_deleted

When a value has been deleted for a project resource custom field.
workspace_resource:
custom_field_value_updated

When a value has been created for a project resource custom field.

 

Time Entry
Event Properties
time_entry:deleted
When a time entry is deleted.
id  (integer) — The ID of the time entry.
account_id  (integer) — The ID of the account the time was entered in.
amount_in_subunits  (integer) — The cost to perform the work, in cents or another currency subunit.
billable  (boolean) Whether the work for the time entry is billable.
created_at  (date-time) — When the time was entered.
currency  (string) Currency of the project when the time was entered.
date  (date) — When the work was performed, that the time entry is for.
story_id  (integer) — The ID of the task the time was entered for.
time  (integer) — The amount of work that was performed, in minutes.
updated_at  (date-time) — When the time entry was last updated.
user_id  (integer) — The ID of the user who entered the time.
workspace_id  (integer) — The ID of the project the time was entered in.

 

Expense
Event Properties
expense:deleted
When an expense is deleted.
id  (integer) — The ID of the expense.
account_id  (integer) — The ID of the account the expense was entered in.
active_invoice_id  (integer) — The ID of the active invoice the expense is included in.
active_submission_id  (integer) — The ID of the active expense report the expense was submitted in.
amount_in_subunits  (integer) — The amount of the expense, in cents or another currency subunit.
approved  (boolean) — Whether the expense is approved. True indicates an approved expense, and False indicates not approved.
category  (string) — The category of the expense. Mavenlink default categories are: Travel, Mileage, Lodging, Food, Entertainment, and Other.
created_at  (date-time) — When the expense was entered.
currency  (string) The currency the expense is in.
date  (date) — When the expense was incurred.
expense_category_id  (integer) — The ID of the category of the expense.
is_billable  (boolean) — Whether the expense is billable. True indicates a billable expense, and False indicates not billable.
recent_submission_id  (integer) — The ID of the most recent expense report the expense was submitted in, including canceled and rejected reports.
role_id  (integer) — The ID of the role of the user who entered the expense.
story_id  (integer) — The ID of the task the expense was entered for.
taxable  (boolean) — Whether the expense is taxable. True indicates a taxable expense, and False indicates not taxable.
updated_at  (date-time) — When the expense was last updated.
user_id  (integer) — The ID of the user who entered the expense.
workspace_id  (integer) — The ID of the project the time was entered in.

 

Created on