Docs

List feed items

Returns a paginated list of feed items for a user in reverse chronological order, including metadata about the feed. If the user has not yet been identified within Knock, an empty feed will be returned. You can customize the response using [response filters](/integrations/in-app/knock#customizing-api-response-content) to exclude or only include specific properties on your resources. **Notes:** * When making this call from a client-side environment, use your publishable key along with a user token. * This endpoint’s rate limit is always scoped per-user and per-environment. This is true even for requests made without a signed user token. * Any [attachments](/integrations/email/attachments) present in trigger data are automatically excluded from both the `data` and `activities` fields of `UserInAppFeedResponse`.

List feed items

You can customize the response using response filters to exclude or only include specific properties on your resources.

Notes:

When making this call from a client-side environment, use your publishable key along with a user token.
This endpoint’s rate limit is always scoped per-user and per-environment. This is true even for requests made without a signed user token.
Any attachments present in trigger data are automatically excluded from both the data and activities fields of UserInAppFeedResponse.

Endpoint

GET/v1/users/{user_id}/feeds/{id}

Rate limit

Tier 2

Path parameters

user_id

string

The unique identifier of the user.

string(uuid)

The unique identifier for the channel.

Query parameters

status

enum(string)

The status of the feed items.

unreadreadunseenseenall

source

string

The workflow key associated with the message in the feed.

tenant

string

The tenant associated with the feed items.

has_tenant

boolean

Whether the feed items have a tenant.

workflow_categories[]

string[]

The workflow categories of the feed items.

archived

enum(string)

The archived status of the feed items.

excludeincludeonly

trigger_data

string

The trigger data of the feed items (as a JSON string).

locale

string

The locale to render the feed items in. Must be in the IETF 5646 format (e.g. en-US). When not provided, will default to the locale that the feed items were rendered in. Only available for enterprise plan customers using custom translations.

after

string

The cursor to fetch entries after.

before

string

The cursor to fetch entries before.

page_size

integer

The number of items per page (defaults to 50).

Returns

UserInAppFeedResponse

A paginated list of feed items.

entries

InAppFeedItem[]

The list of feed items in the user's feed.

__typename

string

Required

The typename of the schema.

activities

Activity[]

Required

List of activities associated with this feed item.

__typename

string

The typename of the schema.

actor

Recipient

The actor who performed the activity.

data

object(any)

The workflow trigger data payload associated with the activity.

string

Unique identifier for the activity.

inserted_at

string(date-time)

Timestamp when the activity was created.

recipient

2 possible types

A recipient of a notification, which is either a user or an object.

updated_at

string(date-time)

Timestamp when the activity was last updated.

actors

Recipient[]

Required

List of actors associated with this feed item.

archived_at

string

Timestamp when the feed item was archived.

blocks

object[]

Required

Content blocks that make up the feed item.

clicked_at

string

Timestamp when the feed item was clicked.

data

object(any)

Required

Additional data associated with the feed item.

string

Required

Unique identifier for the feed.

inserted_at

string

Required

Timestamp when the resource was created.

interacted_at

string

Timestamp when the feed item was interacted with.

link_clicked_at

string

Timestamp when a link within the feed item was clicked.

read_at

string

Timestamp when the feed item was marked as read.

seen_at

string

Timestamp when the feed item was marked as seen.

source

object

Required

Source information for the feed item.

__typename

string

Required

The typename of the schema.