Activity Schema

Verbs

The following verbs are defined by this specification:

Name Identifier Description
accept accept Indicates that that the actor has accepted the object. For instance, a person accepting an award, or accepting an assignment.
access access Indicates that the actor has accessed the object. For instance, a person accessing a room, or accessing a file.
acknowledge acknowledge Indicates that the actor has acknowledged the object. This effectively signals that the actor is aware of the object's existence.
add add Indicates that the actor has added the object to the target. For instance, adding a photo to an album.
agree agree Indicates that the actor agrees with the object. For example, a person agreeing with an argument, or expressing agreement with a particular issue.
append append Indicates that the actor has appended the object to the target. For instance, a person appending a new record to a database.
approve approve Indicates that the actor has approved the object. For instance, a manager might approve a travel request.
archive archive Indicates that the actor has archived the object.
assign assign Indicates that the actor has assigned the object to the target.
at at Indicates that the actor is currently located at the object. For instance, a person being at a specific physical location.
attach attach Indicates that the actor has attached the object to the target. For instance, a person attaching a file to a wiki page or an email.
attend attend Indicates that the actor has attended the object. For instance, a person attending a meeting.
author author Indicates that the actor has authored the object. Note that this is a more specific form of the verb "create".
authorize authorize Indicates that the actor has authorized the object. If a target is specified, it means that the authorization is specifically in regards to the target. For instance, a service can authorize a person to access a given application; in which case the actor is the service, the object is the person, and the target is the application. In contrast, a person can authorize a request; in which case the actor is the person and the object is the request and there might be no explicit target.
borrow borrow Indicates that the actor has borrowed the object. If a target is specified, it identifies the entity from which the object was borrowed. For instance, if a person borrows a book from a library, the person is the actor, the book is the object and the library is the target.
build build Indicates that the actor has built the object. For example, if a person builds a model or compiles code.
cancel cancel Indicates that the actor has canceled the object. For instance, canceling a calendar event.
checkin checkin Indicates that the actor has checked-in to the object. For instance, a person checking-in to a Place.
close close Indicates that the actor has closed the object. For instance, the object could represent a ticket being tracked in an issue management system.
complete complete Indicates that the actor has completed the object.
confirm confirm Indicates that the actor has confirmed or agrees with the object. For instance, a software developer might confirm an issue reported against a product.
consume consume Indicates that the actor has consumed the object. The specific meaning is dependent largely on the object's type. For instance, an actor may "consume" an audio object, indicating that the actor has listened to it; or an actor may "consume" a book, indicating that the book has been read. As such, the "consume" verb is a more generic form of other more specific verbs such as "read" and "play".
create create Indicates that the actor has created the object.
delete delete Indicates that the actor has deleted the object. This implies, but does not require, the permanent destruction of the object.
deliver deliver Indicates that the actor has delivered the object. For example, delivering a package.
deny deny Indicates that the actor has denied the object. For example, a manager may deny a travel request.
disagree disagree Indicates that the actor disagrees with the object.
dislike dislike Indicates that the actor dislikes the object. Note that the "dislike" verb is distinct from the "unlike" verb which assumes that the object had been previously "liked".
experience experience Indicates that the actor has experienced the object in some manner. Note that, depending on the specific object types used for both the actor and object, the meaning of this verb can overlap that of the "consume" and "play" verbs. For instance, a person might "experience" a movie; or "play" the movie; or "consume" the movie. The "experience" verb can be considered a more generic form of other more specific verbs as "consume", "play", "watch", "listen", and "read"
favorite favorite Indicates that the actor marked the object as an item of special interest.
find find Indicates that the actor has found the object.
flag-as-inappropriate flag-as-inappropriate Indicates that the actor has flagged the object as being inappropriate for some reason. When using this verb, the "context" property can be used to provide additional detail about why the object has been flagged.
follow follow Indicates that the actor began following the activity of the object. In most cases, the object will be a Person, but it can potentially be of any type that can sensibly generate activity. Processors MAY ignore (silently drop) successive identical "follow" activities.
give give Indicates that the actor is giving an object to the target. Examples include one person giving a badge object to another person. The object identifies the object being given. The target identifies the receiver.
host host Indicates that the actor is hosting the object. As in hosting an event, or hosting a service.
ignore ignore Indicates that the actor has ignored the object. For instance, this verb may be used when an actor has ignored a friend request, in which case the object may be the request-friend activity.
insert insert Indicates that the actor has inserted the object into the target.
install install Indicates that the actor has installed the object, as in installing an application.
interact interact Indicates that the actor has interacted with the object. For instance, when one person interacts with another.
invite invite Indicates that the actor has invited the object, typically a person object, to join or participate in the object described by the target. The target could, for instance, be an event, group or a service.
join join Indicates that the actor has become a member of the object. This specification only defines the meaning of this verb when its object is a group, though implementors SHOULD be prepared to handle other Object types a meaning MAY be provided by extension specifications. Processors MAY ignore (silently drop) successive identical "join" activities.
leave leave Indicates that the actor has left the object. For instance a Person leaving a Group or checking-out of a Place.
like like Indicates that the actor marked the object as an item of special interest. The "like" verb is considered to be an alias of "favorite". The two verb are semantically identical.
listen listen Indicates that the actor has listened to the object. This is typically only applicable for objects representing audio content, such as music, an audio-book, or a radio broadcast. The "listen" verb is a more specific form of the "consume", "experience" and "play" verbs.
lose lose Indicates that the actor has lost the object. For instance, if a person loses a game.
make-friend make-friend Indicates the creation of a friendship that is reciprocated by the object. Since this verb implies an activity on the part of its object, processors MUST NOT accept activities with this verb unless they are able to verify through some external means that there is in fact a reciprocated connection. For example, a processor may have received a guarantee from a particular publisher that the publisher will only use this Verb in cases where a reciprocal relationship exists.
open open Indicates that the actor has opened the object. For instance, the object could represent a ticket being tracked in an issue management system.
play play Indicates that the actor spent some time enjoying the object. For example, if the object is a video this indicates that the subject watched all or part of the video.
present present Indicates that the actor has presented the object. For instance, when a person gives a presentation at a conference.
purchase purchase Indicates that the actor has purchased the object. If a target is specified, in indicates the entity from which the object was purchased.
qualify qualify Indicates that the actor has qualified for the object. If a target is specified, it indicates the context within which the qualification applies.
read read Indicates that the actor read the object. This is typically only applicable for objects representing printed or written content, such as a book, a message or a comment. The "read" verb is a more specific form of the "consume", "experience" and "play" verbs.
receive receive Indicates that the actor is receiving an object. Examples include a person receiving a badge object. The object identifies the object being received.
reject reject Indicates that the actor has rejected the object.
remove remove Indicates that the actor has removed the object from the target.
remove-friend remove-friend Indicates that the actor has removed the object from the collection of friends.
replace replace Indicates that the actor has replaced the target with the object.
request request Indicates that the actor has requested the object. If a target is specified, it indicates the entity from which the object is being requested.
request-friend request-friend Indicates the creation of a friendship that has not yet been reciprocated by the object.
resolve resolve Indicates that the actor has resolved the object. For instance, the object could represent a ticket being tracked in an issue management system.
retract retract Indicates that the actor has retracted the object. For instance, if an actor wishes to retract a previously published activity, the object would be the previously published activity that is being retracted.
return return Indicates that the actor has returned the object. If a target is specified, it indicates the entity to which the object was returned.
rsvp-maybe rsvp-maybe The "possible RSVP" verb indicates that the actor has made a possible RSVP for the object. This specification only defines the meaning of this verb when its object is an event, though implementors SHOULD be prepared to handle other object types as meaning MAY be provided by extension specifications. The use of this verb is only appropriate when the RSVP was created by an explicit action by the actor. It is not appropriate to use this verb when a user has been added as an attendee by an event organiser or administrator.
rsvp-no rsvp-no The "negative RSVP" verb indicates that the actor has made a negative RSVP for the object. This specification only defines the meaning of this verb when its object is an event, though implementors SHOULD be prepared to handle other object types as meaning MAY be provided by extension specifications. The use of this verb is only appropriate when the RSVP was created by an explicit action by the actor. It is not appropriate to use this verb when a user has been added as an attendee by an event organiser or administrator.
rsvp-yes rsvp-yes The "positive RSVP" verb indicates that the actor has made a positive RSVP for an object. This specification only defines the meaning of this verb when its object is an event, though implementors SHOULD be prepared to handle other object types as meaning MAY be provided by extension specifications. The use of this verb is only appropriate when the RSVP was created by an explicit action by the actor. It is not appropriate to use this verb when a user has been added as an attendee by an event organiser or administrator.
satisfy satisfy Indicates that the actor has satisfied the object. If a target is specified, it indicate the context within which the object was satisfied. For instance, if a person satisfies the requirements for a particular challenge, the person is the actor; the requirement is the object; and the challenge is the target.
save save Indicates that the actor has called out the object as being of interest primarily to him- or herself. Though this action MAY be shared publicly, the implication is that the object has been saved primarily for the actor's own benefit rather than to show it to others as would be indicated by the "share" verb.
schedule schedule Indicates that the actor has scheduled the object. For instance, scheduling a meeting.
search search Indicates that the actor is or has searched for the object. If a target is specified, it indicates the context within which the search is or has been conducted.
sell sell Indicates that the actor has sold the object. If a target is specified, it indicates the entity to which the object was sold.
send send Indicates that the actor has sent the object. If a target is specified, it indicates the entity to which the object was sent.
share share Indicates that the actor has called out the object to readers. In most cases, the actor did not create the object being shared, but is instead drawing attention to it.
sponsor sponsor Indicates that the actor has sponsored the object. If a target is specified, it indicates the context within which the sponsorship is offered. For instance, a company can sponsor an event; or an individual can sponsor a project; etc.
start start Indicates that the actor has started the object. For instance, when a person starts a project.
stop-following stop-following Indicates that the actor has stopped following the object.
submit submit Indicates that the actor has submitted the object. If a target is specified, it indicates the entity to which the object was submitted.
tag tag Indicates that the actor has identified the presence of a target inside another object. For example, the actor may have specified that a particular user appears in a photo. The target of the "tag" verb gives the object in which the tag has been added. For example, if a user appears in a photo, the object is the user and the target is the photo.
terminate terminate Indicates that the actor has terminated the object.
tie tie Indicates that the actor has neither won or lost the object. This verb is generally only applicable when the object represents some form of competition, such as a game.
unfavorite unfavorite Indicates that the actor has removed the object from the collection of favorited items.
unlike unlike Indicates that the actor has removed the object from the collection of liked items.
unsatisfy unsatisfy Indicates that the actor has not satisfied the object. If a target is specified, it indicates the context within which the object was not satisfied. For instance, if a person fails to satisfy the requirements of some particular challenge, the person is the actor; the requirement is the object and the challenge is the target.
unsave unsave Indicates that the actor has removed the object from the collection of saved items.
unshare unsahre Indicates that the actor is no longer sharing the object. If a target is specified, it indicates the entity with whom the object is no longer being shared.
update update The "update" verb indicates that the actor has modified the object. Implementors SHOULD use verbs such as "post" where the actor is adding new items to a collection or similar. Update is reserved for modifications to existing object or data such as changing a user's profile information.
use use Indicates that the actor has used the object in some manner.
watch watch Indicates that the actor has watched the object. This verb is typically applicable only when the object represents dynamic, visible content such as a movie, a television show or a public performance. This verb is a more specific form of the verbs "experience", "play" and "consume".
win win Indicates that the actor has won the object. This verb is typically applicable only when the object represents some form of competition, such as a game.

Object Types

The following object types are defined by this specification:

Name Identifier Description
Alert alert Any kind of significant notification.
Application application A software application
Article article An article, such as a news article, knowledge base entry or similar construct
Audio audio An item of audio content
Badge badge A badge or award given to an entity
Binary binary Objects of this type are used to carry arbirary Base64-encoded binary data within an Activity Stream object. It is primarily intended to attach binary data to other types of objects through the use of the "attachments" property.
Bookmark bookmark A pointer to a URL
Collection collection A generic collection of objects of any type.
Comment comment A textual response to another object
Device device A device of any type
Event event An event that occurs in a certain place during a particular interval of time
File file A document or other file with no additional machine-readable semantics
Game game A game or competition of any kind
Group group A social networking group
Image image A graphical image
Issue issue Represents a report about a problem or situation that needs to be resolved. For instance, the issue object can be used to represent reports detailing software defects, or reports of acceptable use violations, and so forth.
Job job A job or job posting.
Link link A link to another resource
Note note A short-form text message
Offer offer An offer of any kind
Organization organization An organization of any kind
Page page Represents an area, typically a web page, that is representative of, and generally managed by a particular entity. Such areas are usually dedicated to displaying descriptive information about the entity and showcasing recent content such as articles, photographs and videos. Most social networking applications, for example, provide individual users with their own dedicated "profile" pages. Several allow similar types of pages to be created for commercial entities, organizations or events. While the specific details of how pages are implemented, their characteristics and use may vary, the one unifying property is that they are typically "owned" by a single entity that is represented by the content provided by the page itself.
Person person A user account
Place place A location on Earth.
Process process Represents any form of process. For instance, a long-running task that is started and expected to continue operating for a period of time.
Product product A commercial good or service
Question question A question or poll
Review review A primarily prosed-based commentary on another object
Service service Something that provides a service to others
Task task An activity that has yet to be completed.
Video video An item of video content

Activity Components

The following activity components are defined by this specification:

Name JSON Property Description
Context context An object construct that provides information about why an activity occurred by describing the context within which it occurred.
Dublin Core dc Dublin Core Metadata related to the object (http://dublincore.org)
End-Time endTime A timestamp indicating the date and time at which the activity ended.
GeoJSON geojson GeoJSON Metadata related to the object (http://www.geojson.org/geojson-spec.html)
Linked Data for JSON ld JSON-LD Metadata related to the object (http://json-ld.org)
Links links Links associated with the object
Location location An object construct representing the location at which the activity occurred.
Mood mood A human-readable keyword or short phrase describing the mood of the actor at the time the activity was performed.
OData odata OData Metadata related to the object (http://www.odata.org)
OpenGraph opengraph OpenGraph Metadata related to the object (http://developers.facebook.com/docs/opengraph)
Rating rating A rating given as a number between 1.0 and 5.0 inclusive with one decimal place of precision.
Result result An object construct that describes the result of an activity.
Schema.org schema_org Schema.org Metadata related to the object (http://schema.org)
Source source A reference to the original source of an object or activity.
Start-Time startTime A timestamp indicating the date and time at which the activity was started.
Tags tags A listing of the objects that have been associated with a particular object using the tag verb.

Object Components

The following object components are defined by this specification:

Name JSON Property Description
Dublin Core dc Dublin Core Metadata related to the object (http://dublincore.org)
End-Time endTime A timestamp indicating the date and time at which the object ended.
GeoJSON geojson GeoJSON Metadata related to the object (http://www.geojson.org/geojson-spec.html)
Linked Data for JSON ld JSON-LD Metadata related to the object (http://json-ld.org)
Links links Links associated with the object
Location location An object construct representing the location at which the activity occured.
Mood mood A human-readable keyword or short phrase describing the mood of the actor at the time the activity was performed.
OData odata OData Metadata related to the object (http://www.odata.org)
OpenGraph opengraph OpenGraph Metadata related to the object (http://developers.facebook.com/docs/opengraph)
Rating rating A rating given as a number between 1.0 and 5.0 inclusive with one decimal place of precision.
Schema.org schema_org Schema.org Metadata related to the object (http://schema.org)
Source source A reference to the original source of an object or activity.
Start-Time startTime A timestamp indicating the date and time at which the object was started.
Tags tags A listing of the objects that have been associated with a particular object using the tag verb.