Activity Feeds v3 is in beta — try it out!

Activities

Creating Activities

The example below shows how to create an activity and add it to a feed.

// Add an activity to 1 feed or multiple feeds
$activity = new GeneratedModels\AddActivityRequest(
    type: 'post',
    feeds: ['user:1', 'stock:apple'],
    text: 'apple stock will go up',
    userID: '<user id>',
    custom: (object)[
        'test_field' => 'test_value',
        'timestamp' => time()
    ]
);
$response = $feedsClient->addActivity($activity);

The above example was quite simple. Here are a few more examples:

Image & Video

$activity = new GeneratedModels\AddActivityRequest(
    type: 'post',
    feeds: ['user:1'],
    text: 'look at NYC',
    userID: '<user id>',
    attachments: [
        new GeneratedModels\Attachment(
            imageUrl: 'https://example.com/image.png',
            type: 'image',
            custom: (object)[]
        )
    ]
);
$response = $feedsClient->addActivity($activity);

Overview of All Activity Fields

Here’s an overview of all the fields you can add when creating an activity:

FieldDescription
idEither set your own id, or let our server generate it. Setting your own ID can be convenient if your activity maps 1 to 1 to something in your database.
typeThe type of activity. Defaults to “post” if not provided.
feedsThe list of feeds (format: “group id:feed id”) to add this activity to
textThe text for this activity
attachmentsA list of attachments. Video, images, location, etc. Also supports custom attachments
customAny custom data you want to add
visibilityVisibility levels for the activity
locationSpecify an activity location. This allows for feeds to show content close to you. Format: ActivityLocation(lat: 40.014984, lng: -105.270546)
expiresAtWhen the activity expires. After this timestamp it’s only visible to the person who created this activity (or server side API calls)
mentionedUserIdsA list of users mentioned in this activity
parentIdThe parent activity. Used for replies/reshares etc
searchDataAny extra data you want to search on for this activity
filterTagsArray of strings that you can filter on when querying the feed
interestTagsEither set the interest tags manually or enable an activity processor to have AI determine the topics for this activity. Used for “for you” style feeds

Adding Many Activities

You can also batch add activities. Here’s an example:

$activities = [
    [
        'feeds' => ['user:123'],
        'id' => '1',
        'type' => 'post',
        'text' => 'hi',
        'user_id' => '<user id>',
    ],
    [
        'feeds' => ['user:456'],
        'id' => '2',
        'type' => 'post',
        'text' => 'hi',
        'user_id' => '<user id>',
    ]
];

$response = $feedsClient->upsertActivities(
    new GeneratedModels\UpsertActivitiesRequest(activities: $activities)
);

Updating & Deleting Activities

This example shows how to update or delete an activity:

// Update an activity
$response = $feedsClient->updateActivity(
    '123',
    new GeneratedModels\UpdateActivityRequest(
        text: 'Updated text',
        userID: '<user id>',
        custom: (object)[
            'color' => 'blue'
        ]
    )
);

// Delete an activity (soft delete sets deleted at but retains the data, hard delete fully removes it)
$response = $feedsClient->deleteActivity('123', false);

// Batch delete activities
$response = $feedsClient->deleteActivities(
    new GeneratedModels\DeleteActivitiesRequest(
        ids: ['123', '456'],
        userID: '<user id>',
        hardDelete: false
    )
);

Partial activity updates

A partial update can be used to set and unset specific fields when it is necessary to retain additional custom data fields on the object. AKA a patch style update. Both set and unset can be used in the same request. The dotted-notation is also available for both set and unset for the custom field.

// Partially set some fields
$response = $feedsClient->updateActivityPartial(
    '123',
    new GeneratedModels\UpdateActivityPartialRequest(
        userID: '<user id>',
        set: [
            'text' => 'Japan has over 6,800 islands.',
            'custom' => [
                'topic' => 'fun facts',
                'color' => 'blue',
            ]
        ]
    )
);

// Partially unset some fields
$response = $feedsClient->updateActivityPartial(
    '123',
    new GeneratedModels\UpdateActivityPartialRequest(
        userID: '<user id>',
        unset: ['custom.color']
    )
);
© Getstream.io, Inc. All Rights Reserved.