Feed

Moxtra user's timeline and conversations are represented as feed. The feed result is in Activity Stream format, which follows the JSON specification. Schemas can be found at: JSON Schema and Activity Base Schema.

Mapping

Verbs Mapping - Between Activity Stream and Moxtra

Description Activity Stream Moxtra
Indicates that the actor has created the object create FEED_BOARD_CREATE, FEED_PAGES_CREATE, FEED_TODO_CREATE
Indicates that the actor has modified the object update FEED_BOARD_NAME_CHANGE, FEED_PAGES_UPDATE, FEED_RELATIONSHIP_CHANGE_ROLE, FEED_TODO_UPDATE, FEED_SESSION_RENAME
Indicates that the actor has post the object to the target post FEED_BOARD_COMMENT, FEED_PAGES_COMMENT, FEED_TODO_COMMENT, FEED_TODO_DUE_DATE
Indicate that the actor has uploaded a file upload FEED_PAGES_CREATE, FEED_TODO_ATTACHMENT
Indicates that the actor has added the object to the target add FEED_RELATIONSHIP_ADD, FEED_TODO_ATTACHMENT
Indicates that the actor has added annotation to the page tag FEED_PAGES_ANNOTATION
Indicates that the actor has accessed the object access FEED_PAGES_VIEW
Indicates that the actor has deleted the object delete FEED_PAGES_DELETE
Indicates that the actor has become a member of the object join FEED_RELATIONSHIP_JOIN
Indicates that the actor has left the object leave FEED_RELATIONSHIP_LEAVE
Indicates that the actor has removed the object from the target remove FEED_RELATIONSHIP_REMOVE
Indicates that the actor has invited the object invite FEED_RELATIONSHIP_INVITE
Indicates that the actor has ignored the object ignore FEED_RELATIONSHIP_DECLINE
Indicates that the actor has canceled the object cancel FEED_RELATIONSHIP_CANCEL, FEED_SESSION_CANCEL
Indicates that the actor has assigned person or group to the todo give FEED_TODO_ASSIGN
Indicate that the actor has completed the todo complete FEED_TODO_COMPLETE
Indicate that the actor has reopened the todo reopen FEED_TODO_REOPEN
Indicate that the todo is due due FEED_TODO_DUE_DATE_ARRIVE
Indicate that a meet was scheduled schedule FEED_SESSION_SCHEDULE
Indicate that a meet was rescheduled reschedule FEED_SESSION_RESCHEDULE
Indicate that a meet was started start FEED_SESSION_START
Indicate that a meet was ended end FEED_SESSION_END
Indicate that a meet recording is ready recording_ready FEED_SESSION_RECORDING_READY

Objects Mapping - Between Activity Stream and Moxtra

Description Activity Stream Moxtra
Represents a textual response to another object comment comment
Represents an area, typically a web page, that is representative of, and generally managed by a particular entity page page
Represents a generic collection of objects of various types binder - based on collection binder
Represents an individual person person user
The "group" object type represents a grouping of objects in which member objects can join or leave group group
Represents any form of document or file file resource
Represents an annotation event annotation - based on note annotation
Represents a generic collection of objects of any type. Currently, person and group types are supported collection object array
Represents a todo task todo - based on service todo
Represents a due date event duedate - based on note duedate in todo
Represents any kind of event event event
Represents a meet meet - based on collection meet

Object Details

Person

The "person" object type represents a user account.
Property Value Description
objectType String person
displayName String The user's full name
image Media link The link to the user's profile picture
id String The unique identifier for the person object
published String The optional time the person object was created in the form of an [RFC3339] "date-time"
updated String The optional time the person object was last updated in the form of an [RFC3339] "date-time"
url no use
email String The email address of the user.
unique_id String The unique_id of the user if the user is created on unique_id instead of email.

Group

The "group" object type represents a grouping of objects in which member objects can join or leave.
Property Value Description
objectType String group
displayName String The group's name
id String The unique identifier for the group object
published String The optional time the group object was created in the form of an [RFC3339] "date-time"
updated String The optional time the group object was last updated in the form of an [RFC3339] "date-time"
url no use

Collection

The "collection" object type represents a generic collection of objects of any type. Currently, person and group types are supported.
Property Value Description
objectType String collection
totalItems Integer Non-negative integer specifying the total number of activities within the stream.
items Array of Objects An array containing a listing of Objects of any object type. Currently, person and group types are supported.
url no use

Comment

The "comment" object type represents a textual response to another object.
Property Value Description
objectType String comment
id String The unique identifier for the comment object
published String The optional time the comment object was created in the form of an [RFC3339] "date-time"
updated String The optional time the comment object was last updated in the form of an [RFC3339] "date-time"
content String The main body content represented as a fragment of HTML. The text content is enclosed with <p> tag and audio content is enclosed with <audio> tag.
content_text String The main body content without HTML tags around it.
content_richtext String The richtext comment in BBCode style.
displayName no use
inReplyTo no use
author omitted for using the Activity Stream's Actor

Binder

The "binder" object type represents a generic collection of objects of other types.
Property Value Description
objectType String binder
id String The unique identifier for the binder object
published String The optional time the binder object was created in the form of an [RFC3339] "date-time"
updated String The optional time the binder object was last updated in the form of an [RFC3339] "date-time"
displayName String The binder's name
image Media link The thumbnail link to the binder
url String The link to the binder

File

The "file" object type represents some document or other file with no additional machine-readable semantics.
Property Value Description
objectType String file
id String The unique identifier for the file object
published String The optional time the file object was created in the form of an [RFC3339] "date-time"
updated String The optional time the file object was last updated in the form of an [RFC3339] "date-time"
displayName String The file's name
mimeType String The MIME type of the file described by the object
url no use
author omitted for using the Activity Stream's Actor

Page

The "page" object type represents an area, typically a web page, that is representative of, and generally managed by a particular entity.
Property Value Description
objectType String page
id String The unique identifier for the page object
published String The optional time the page object was created in the form of an [RFC3339] "date-time"
updated String The optional time the page object was last updated in the form of an [RFC3339] "date-time"
type String The page type
url String The resource link to the page
displayName no use
author omitted for using the Activity Stream's Actor

Annotation

The "annotation" object represents an update event for the annotation.
Property Value Description
objectType String annotation
published String The optional time the annotation object was created in the form of an [RFC3339] "date-time"
updated String The optional time the annotation object was last updated in the form of an [RFC3339] "date-time"

Todo

The "todo" object represents an update event for the todo and it is based on Service object.
Property Value Description
objectType String todo
id String The unique identifier for the todo object
displayName String The todo's name
summary String The description of the todo
published String The optional time the todo object was created in the form of an [RFC3339] "date-time"
updated String The optional time the todo object was last updated in the form of an [RFC3339] "date-time"
url no use
image no use

Duedate

The "duedate" object represents an update event for the duedate and it is based on Note object.
Property Value Description
objectType String duedate
id String The unique identifier for the duedate object
content String The duedate in the form of an [RFC3339] "date-time"
published String The optional time the duedate object was created in the form of an [RFC3339] "date-time"
updated String The optional time the duedate object was last updated in the form of an [RFC3339] "date-time"
url no use

Event

The "event" object type represents any kind of event.
Property Value Description
objectType String event
displayName String The event's name
published String The optional time the event object was created in the form of an [RFC3339] "date-time"
updated String The optional time the event object was last updated in the form of an [RFC3339] "date-time"
url no use

Meet

The "meet" object type represents a meet.
Property Value Description
objectType String meet
id String The session_key of the meet
displayName String The meet's topic
published String The optional time the meet object was created in the form of an [RFC3339] "date-time"
updated String The optional time the meet object was last updated in the form of an [RFC3339] "date-time"
status String The status of the meet object: SESSION_SCHEDULED, SESSION_STARTED, SESSION_ENDED
start_time String The meet's start time in the form of an [RFC3339] "date-time"
end_time String The meet's end time in the form of an [RFC3339] "date-time"
recording_url String The link to the meet recording

Contacts

Here are some samples:

Post Comment to Binder
{
    "object": {
        "id": "34",
        "content": "<p>Next</p>",
        "content_text": "Next",
        "content_richtext": "",
        "objectType": "comment",
        "updated": "2013-08-16T01:41:48Z",
        "published": "2013-08-16T01:41:48Z"
    },
    "target": {
        "id": "BRTaH8slmbPAY4odz0RbBIF",
        "displayName": "My Default Binder",
        "url": "https://www.moxtra.com/BRTaH8slmbPAY4odz0RbBIF",
        "image": "https://www.moxtra.com/board/BRTaH8slmbPAY4odz0RbBIF/25",
        "objectType": "binder",
        "updated": "2013-09-16T22:50:33Z",
        "published": "1970-01-01T00:00:00Z"
    },
    "actor": {
        "image": null,
        "id": "Utkj3YC5BxRHCCaq9widP67",
        "displayName": "Jona Smith",
        "objectType": "person",
        "updated": "2013-09-09T22:00:23Z",
        "published": "2013-05-22T21:21:36Z"
    },
    "generator": {
        "id": "BRTaH8slmbPAY4odz0RbBIF"
    },
    "published": "2013-08-16T01:41:48Z",
    "verb": "post"
}
Post Comment to Page
{
    "object": {
        "id": "69",
        "content": "<p>Welsh</p>",
        "content_text": "Welsh",
        "content_richtext": null,        
        "objectType": "comment",
        "updated": "2013-09-16T21:12:43Z",
        "published": "2013-09-16T21:12:43Z"
    },
    "target": {
        "id": "40",
        "type": "PAGE_TYPE_IMAGE",
        "url": "https://www.moxtra.com/BRTaH8slmbPAY4odz0RbBIF/40",
        "objectType": "page",
        "updated": "1970-01-01T00:00:00Z",
        "published": "1970-01-01T00:00:00Z"
    },
    "actor": {
        "image": "",
        "id": "Utkj3YC5BxRHCCaq9widP67",
        "displayName": "Jona Smith",
        "objectType": "person",
        "updated": "2013-09-09T22:00:23Z",
        "published": "2013-05-22T21:21:36Z"
    },
    "generator": {
        "id": "BRTaH8slmbPAY4odz0RbBIF"
    },
    "published": "2013-09-16T21:12:43Z",
    "verb": "post"
}
Create a Page
{
    "object": {
        "id": "40",
        "type": "PAGE_TYPE_IMAGE",
        "url": "https://www.moxtra.com/BRTaH8slmbPAY4odz0RbBIF/40",
        "objectType": "page",
        "updated": "1970-01-01T00:00:00Z",
        "published": "1970-01-01T00:00:00Z"
    },
    "target": {
        "id": "BRTaH8slmbPAY4odz0RbBIF",
        "displayName": "My Default Binder",
        "url": "https://www.moxtra.com/BRTaH8slmbPAY4odz0RbBIF",
        "image": "https://www.moxtra.com/board/BRTaH8slmbPAY4odz0RbBIF/25",
        "objectType": "binder",
        "updated": "2013-09-16T22:50:33Z",
        "published": "1970-01-01T00:00:00Z"
    },
    "actor": {
        "image": "",
        "id": "Utkj3YC5BxRHCCaq9widP67",
        "displayName": "Jona Smith",
        "objectType": "person",
        "updated": "2013-09-09T22:00:23Z",
        "published": "2013-05-22T21:21:36Z"
    },
    "generator": {
        "id": "BRTaH8slmbPAY4odz0RbBIF"
    },
    "published": "2013-08-29T22:05:16Z",
    "verb": "create"
}
Upload a File
{
    "object": {
        "id": "346",
        "displayName": "Moxtra Integration Overview.pptx",
        "mimeType": "application/vnd.ms-powerpoint",
        "objectType": "file",
        "updated": "2013-09-16T22:46:50Z",
        "published": "2013-09-16T22:46:14Z"
    },
    "target": {
        "id": "BRTaH8slmbPAY4odz0RbBIF",
        "displayName": "My Default Binder",
        "url": "https://www.moxtra.com/BRTaH8slmbPAY4odz0RbBIF",
        "image": "https://www.moxtra.com/board/BRTaH8slmbPAY4odz0RbBIF/25",
        "objectType": "binder",
        "updated": "2013-09-16T22:50:33Z",
        "published": "1970-01-01T00:00:00Z"
    },
    "actor": {
        "image": "",
        "id": "Utkj3YC5BxRHCCaq9widP67",
        "displayName": "Jona Smith",
        "objectType": "person",
        "updated": "2013-09-09T22:00:23Z",
        "published": "2013-05-22T21:21:36Z"
    },
    "generator": {
        "id": "BRTaH8slmbPAY4odz0RbBIF"
    },
    "published": "2013-09-16T22:46:14Z",
    "verb": "upload"
}
Annotation event
{
    "object": {
        "objectType": "annotation",
        "updated": "2013-09-16T21:17:39Z",
        "published": "2013-09-16T21:17:39Z"
    },
    "target": {
        "id": "90",
        "type": "PAGE_TYPE_WHITEBOARD",
        "url": "https://www.moxtra.com/BRTaH8slmbPAY4odz0RbBIF/90",
        "objectType": "page",
        "updated": "1970-01-01T00:00:00Z",
        "published": "1970-01-01T00:00:00Z"
    },
    "actor": {
        "image": "",
        "id": "Utkj3YC5BxRHCCaq9widP67",
        "displayName": "Jona Smitch",
        "objectType": "person",
        "updated": "2013-09-09T22:00:23Z",
        "published": "2013-05-22T21:21:36Z"
    },
    "generator": {
        "id": "BRTaH8slmbPAY4odz0RbBIF"
    },
    "published": "2013-09-16T21:17:39Z",
    "verb": "tag"
}