Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Knock Feeds API

The Feeds API from Knock — 2 operation(s) for feeds.

Knock Feeds API is one of 19 APIs that Knock publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Feeds. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 2 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://api.knock.app.

2 operations 2 paths 10 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://api.knock.app/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Knock Feeds API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Feeds 2
GET
/v1/users/{user_id}/feeds/{id}
List feed items
listUserInAppFeedItems 19 params → 200
GET
/v1/users/{user_id}/feeds/{id}/settings
Get feed settings
getUserInAppFeedSettings 2 params → 200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are InAppFeedItem (18 properties), User (9 properties), Activity (7 properties), Object (6 properties). Each schema is shown below with its type and property counts.

PageInfo
object
Pagination information for a list of resources.
4 properties 2 required
Object
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
6 properties 4 required
InAppFeedItem
object
An in-app feed message in a user's feed.
18 properties 12 required
Recipient
object
A recipient of a notification, which is either a user or an object.
UserInAppFeedResponse
object
A paginated list of feed items.
4 properties 4 required
Activity
object
An activity associated with a workflow trigger request. Messages produced after a [batch step](/designing-workflows/batch-function) can be associated with one…
7 properties
MessageInAppFeedButtonSetBlock
object
A button set block in a message in an app feed.
3 properties 3 required
User
object
A [User](/concepts/users) represents an individual in your system who can receive notifications through Knock. Users are the most common recipients of notifica…
9 properties 3 required
UserInAppFeedSettingsResponse
object
The response for the user's feed settings.
1 property 1 required
MessageInAppFeedContentBlock
object
A block in a message in an app feed.
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-feeds-api-openapi.yml Raw ↑

Other APIs Knock publishes across the network.

Knock Audiences API
Knock Bulk operations API
Knock Channel data API
Knock Guides API
Knock Integrations API
Knock Messages API
Knock Microsoft Teams API
Knock Objects API
Knock Preferences API
Knock Providers API
Knock Schedules API
Knock Slack API