Activity History - Overview

Activity History is a change event to an Activity - which can be considered an "audit trail" event for the Activity.

Methods

The API supports the following methods for Activity History resources:

• GET - History List
  • Get a list of history for a list of either internal_activity_ids or internal_project_ids.

Resource Representation

The following JSON structure shows the format of an Activity History resource:

{
    "id": integer,
    "internal_activity_history_id": string,
    "internal_account_id": string,
    "activity_id": integer,
    "activity_internal_id": string,
    "type": string,
    "subject": string,
    "subject_id": integer,
    "subject_internal_id": string,
    "actor": {
        "internal_user_id": string,
        "email": string,
        "full_name": string
    },
    "timestamp": string (RFC 3339 Format - 2022-05-03T17:13:44Z),
    "custom_message": string,
    "previous_value": string,
    "current_value": string,
    "consumed_at": string (RFC 3339 Format - 2022-05-03T17:13:44Z)
}

Resource Properties

The following table defines the properties that appear in this resource:

Key	Type	Definition
id	integer	The ID of the Activity History.
internal_activity_history_id	string	The ID of the Activity History on your internal system.
internal_account_id	string	The ID of the Account on your internal system.
activity_id	integer	The ID of the Activity.
activity_internal_id	string	The ID of the Activity on your internal system.
type	string	The type of activity history.
subject	ENUM('comment','document')	The string resource type of the history subject if one applies.
subject_id	integer	The ID of the Subject Resource on your internal system.
subject_internal_id	string	The ID of the Subject Resource on your internal system.
actor.internal_user_id	string	The ID of the user on your internal system.
actor.email	string	The email of the user on your internal system.
actor.full_name	string	The full name of the user on your internal system, or within Incentify.
timestamp	string	The date and time that the Activity History occured. The value is specified in RFC 3339 Format (2022-05-03T17:13:44Z).
custom_message	string	A custom message representing this history (if this applies).
previous_value	string	The value before this history occured (if this applies).
current_value	string	The value after this history occured (if this applies).
consumed_at	string	The date and time that the Activity was last consumed and injested into your internal system. The value is specified in RFC 3339 Format (2022-05-03T17:13:44Z).

Available History Types

ENUM('created','deleted','assigned','emailed','accessed','status_changed','due_date_changed', 'downloaded')

• activity created
• activity deleted
• activity assigned
• activity emailed
• activity notification sent???
• activity accessed
• activity status changed
• activity due date changed
• activity document added
• activity document deleted
• activity document downloaded
• activity comment added