Pre-1.0. Not intended for public use yet. The API is subject to undocumented change, and these pages may already be wrong about it.

Storyfeed

Appearance

Introduction ​

Storyfeed provides activity feeds for Laravel. You explicitly record activities and display them as a live feed, a summary, or a log. Storyfeed also serializes activities as W3C Activity Streams 2.0 documents.

Activities ​

An activity records an action and the entities involved. Each entity has a role:

The actor is who did it. The verb is what happened. The object is what it was done to, and the target is what it was aimed at.

Erica Sinclair (actor) placed (verb) Order #1035 (object) with Scoops Ahoy (target)

Different Headlines for the Same Activity ​

You may change an activity's headline without changing its recorded verb or roles. Each example below uses the place verb:

Erica Sinclair (actor) sent (headline) Order #1035 (object) to Scoops Ahoy (target)

A new order, Order #1035 (object), came in (headline) to Scoops Ahoy (target) from Erica Sinclair (actor)

ES
A new order, Order #1035, came in to Scoops Ahoy from Erica Sinclair

Scoops Ahoy (target) received (headline) Order #1035 (object) from Erica Sinclair (actor)

ES
Scoops Ahoy received Order #1035 from Erica Sinclair

Examples From Other Apps ​

Robin Buckley (actor) completed (verb) Crack the code (object) on the Scoops Troop board (target)

RB
Robin Buckley completed Crack the code on the Scoops Troop board
Crack the code

Work out what the Russian message on the tape is saying.

Steve Harrington (actor) signed (verb) the Scoops Ahoy employment contract (object)

SH
Steve Harrington signed the Scoops Ahoy employment contract

scoops-ahoy-employment-contract.pdf · 47 KB · application/pdf

Erica Sinclair (actor) joined (verb) the Scoops Troop (target)

Recording Activities ​

After installing Storyfeed and completing the Quickstart, publish an activity where your application places the order:

Where the order is placed: a controller, an action, a listener
php
use Storyfeed\Facades\Storyfeed;

Storyfeed::activity()
    ->by($customer)
    ->action('place', $order)
    ->to($shop)
    ->publish();
php
use Storyfeed\Facades\Storyfeed;

Storyfeed::record(
    verb: 'place',
    object: $order,
    actor: $customer,
    target: $shop,
);

Displaying Feeds ​

You may display the same activities in three modes. See Retrieving Feeds to select a mode.

Live ​

Live mode is the default. It groups repeated actions and activities from several actors with the same target into single rows.

Today

A
Alexei played a carnival game 3 times
MBJTKW
Murray Bauman, Jasper Tey and Karen Wheeler checked in at the Fun Fair
JT
Jasper Tey went on 3 rides at the Fun Fair
the carousel
S
Stripe processed 3 payments

Yesterday

RB
Robin Buckley completed Find where the elevator goes on the Scoops Troop board
Find where the elevator goes

Find out where the elevator in the storeroom goes down to.

Saturday

DD
Doris Driscoll phoned the Hawkins Post about the rats
DH
Dustin Henderson radioed Suzie 2 times
DH
Dustin Henderson checked in at Weathertop

Oct 28, 1984

MM
Max Mayfield set a new high score on Dig Dug at the Palace Arcade

Summary ​

Summary mode groups activities by actor and day, with one phrase per verb. Actors with the same single activity may share a row.

Today

A
Alexei played 3 games and won a stuffed Woody Woodpecker
MBKW
Murray Bauman and Karen Wheeler checked in at the Fun Fair
JT
Jasper Tey checked in at the Fun Fair, got a red, white and blue balloon and went on 3 rides
the carousel
S
Stripe processed 3 payments

Yesterday

RB
Robin Buckley completed Find where the elevator goes on the Scoops Troop board
Find where the elevator goes

Find out where the elevator in the storeroom goes down to.

Saturday

DD
Doris Driscoll phoned the Hawkins Post about the rats
DH
Dustin Henderson checked in at Weathertop and radioed Suzie 2 times

Oct 28, 1984

MM
Max Mayfield set a new high score on Dig Dug at the Palace Arcade

Log ​

Log mode displays each activity in a separate row.

Today

MB
Murray Bauman checked in at the Fun Fair
JT
Jasper Tey rode the carousel at the Fun Fair
the carousel
the carousel
JT
Jasper Tey checked in at the Fun Fair
KW
Karen Wheeler checked in at the Fun Fair
S
Stripe marked Scoops Ahoy invoice #1988 paid
Scoops Ahoy invoice #1988
Amount
$148.80
Billed to
Starcourt Mall
Reference
INV-1988
S
Stripe marked Scoops Ahoy invoice #1987 paid
Scoops Ahoy invoice #1987
Amount
$96.00
Billed to
Starcourt Mall
Reference
INV-1987
S
Stripe marked Scoops Ahoy invoice #1986 paid
Scoops Ahoy invoice #1986
Amount
$610.40
Billed to
Starcourt Mall
Reference
INV-1986

Yesterday

RB
Robin Buckley completed Find where the elevator goes on the Scoops Troop board
Find where the elevator goes

Find out where the elevator in the storeroom goes down to.

Saturday

DD
Doris Driscoll phoned the Hawkins Post about the rats
DH
Dustin Henderson radioed Suzie
DH
Dustin Henderson radioed Suzie
DH
Dustin Henderson checked in at Weathertop

Oct 28, 1984

MM
Max Mayfield set a new high score on Dig Dug at the Palace Arcade

Released under the MIT License.

Copyright © 2026–present Tey Labs