Events (requires subscription)
| Event Type | Description |
| -------------------- | ----------------------------------------------------------------- |
| create-thread | A thread was created. Additional data on the type of creation can |
| | be found in sub_action; the options are: create-new, |
| | create-import, create-copy |
| open-thread | A thread was opened |
| delete-thread | A thread was deleted |
| share-thread | Additional members were added to a thread. Additional data on the |
| | type of sharing can be found in sub_action |
| unshare-thread | Members of a thread were removed |
| move-thread | A thread was moved from one folder into another folder, a thread |
| | is deleted and moved to trash, or a thread is restored from trash |
| | and moved back to a folder |
| send-message | A message was sent. This event type is a subset of create-message,|
| | including annotation, sending message in conversation pane, and |
| | sending a direct message |
| | |
| | NOTE: Because send-message is a subset of create-message, We |
| | recommend developers use create-message |
| delete-message | A message was deleted |
| edit-message | A message was edited |
| create-message | A message was created and sent. Additional data on the type of |
| | message can be found in sub_action. The options are: annotation, |
| | sending message in conversation pane, sending a direct message, |
| | and ending an edit session, which sends edits to the conversation |
| | pane |
| | |
| | NOTE: create-message is the preferred event type moving forward; |
| | we advise developers to rely on this instead of send-message |
| create-folder | A folder was created |
| delete-folder | A folder was deleted |
| open-folder | A folder was opened |
| move-folder | A folder was moved |
| copy-folder | A folder was copied |
| share-folder | A folder was shared |
| unshare-folder | Members of a folder were removed |
| login | A site member logged in |
| print-document | A thread was printed |
| export-thread | A thread was exported |
| upload_blob-thread | A file was uploaded to a thread |
| create-user | A site member was created |
| disable-user | A site member was disabled |
| admin_edit | An admin took an action in the admin console |
| admin_api_call | An admin API endpoint was accessed |
| restore-thread | Thread removed from the trash by a user, restoring access |
| create-policy | A data retention or data hold policy was created |
| retire-policy | A data retention or data hold policy was retired |
| attach-policy | A data retention or data hold policy was attached to a thread |
| execute-policy | The policy action on a data hold or data retention was executed |
| create-link | A shareable link for a thread was created |
| edit-link | A sharaeble link's access to a thread was changed |
| delete-link | A sharaeble link for a thread was disabled |
| download_blob-thread | A file attachment of a thread downloaded by user |
| search_threads | A search query across corpus of threads |
| receive-invite | A site member was added to a thread |
| receive_in_folder-thread | A thread was added to a folder your company owns |
| receive_folder | A site member was added to a folder |
| joined_by_link-thread| A member joined a thread your company owns by link share |
| join-thread | A site member joins a thread by link thread |
| create-link | A link for a thread or folder your company was created |
| joined_by_link-folder| A member joined a folder your company owns by link share |
| join-folder | A site member joins a folder by link thread |
Event JSON
Responses format individual events as a JSON dictionary described below.
| Field | Description |
|------------------------------------------------------------------------------------------------|
| time_usec | Server timestamp in microseconds |
| ip | IP address of the client, if present |
| user_agent | Software agent acting on behalf of the user, such as a browser |
| device | Platform type used by user |
| quip_version | Software version, only present for some device types |
| id | Unique id for the event |
| action | Action taken by user |
| sub_action | More detailed description of the action taken by user |
| object | What the action acted upon |
| child_object | More detailed description of the object the action is taken upon |
| user (flattened) | (not a field, represented by fields below) |
| user_id | Unique id of user associated to the event |
| thread (flattened) | (not a field, represented by fields below) |
| thread_id | Unique id of thread associated to the event |
| thread__author_id | Thread creator's user_id |
| thread__thread_type | Valid values: NONE, DOCUMENT, TWO_PERSON_CHAT, GROUP_CHAT, |
| | CHANNEL, FILE_UPLOAD, TASKS_SEARCH, ALERTS_FEED |
| folder (flattened) | (not a field, represented by fields below) |
| folder_id | Unique id of folder associated to the event |
| folder__author_id | Folder creator's user_id |
| folder__folder_type | Valid values: PRIVATE, SHARED |
| company (flattened) | (not a field, represented by fields below) |
| company_id | Unique id of company for user associated to the event |
| document_id | Unique id of document associated to the event |
| link (flattened) | (not a field, represented by fields below) |
| link_id | Unique id for a shareable url link to a thread |
| link__show_conversation | Whether access via the link shows conversation pane |
| link__show_diff | Whether access via the link shows the document changes/diffs |
| link__allow_messages | Whether access via the link allows comments |
| link__enable_request_access | Whether access via the link allows requesting more access |
| link__link_sharing_mode | Updated access level via the link |
| | Valid values: NONE, VIEW, EDIT |
| link__allow_access_outside_domain | Whether access via the link requires authentication to |
| | owning organization |
| recipient_ids | User ids of members shared in a `share` action |
| src_folder_ids | Where the object is moved from in actions like `move` |
| dst_folder_ids | Where the object is moved to in action like `move` |
| annotation (flattened) | (not a field, represented by fields below) |
| annotation_id | Unique id of annotation associated to the event |
| message (flattened) | (not a field, represented by fields below) |
| message_id | Unique id of message associated to the event |
| blob (flattened) | (not a field, represented by fields below) |
| blod_id | Unique id of blob associated to the event |
| policy (flattened) | (not a field, represented by fields below) |
| policy_id | Unique id of policy associated to the event |
Get an Event Cursor
GET https://platform.quip.com/1/admin/events/1/cursor/create Required Scopes
ADMIN_READ Headers
Authorization:
Bearer {{access_token}}Query Params
company_id The company to use
user_id Optional The user to use
event_types Optional since_timestamp in microseconds, e.g. (echo $(( gdate +%s%N / 1000 - (6 * 3600 * 1000000) )))
until_timestamp In microseconds, e.g. (echo $(( gdate +%s%N / 1000 - (5 * 3600 * 1000000) ))
Description
Gets a starting cursor to retrieve historical events.