How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Knock Subscriptions API

A subscription represents a connection between a recipient and an object, used to represent a list.

Knock Subscriptions API is one of 16 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 Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

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

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

4 operations 2 paths 37 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 4

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

Subscriptions 4

A subscription represents a connection between a recipient and an object, used to represent a list.

GET
/v1/users/{user_id}/subscriptions
List user subscriptions
listSubscriptionsForUser 6 params → 200
DELETE
/v1/objects/{collection}/{object_id}/subscriptions
Delete subscriptions
deleteSubscriptionsForObject 2 params body → 200
GET
/v1/objects/{collection}/{object_id}/subscriptions
List subscriptions
listSubscriptionsForObject 9 params → 200
POST
/v1/objects/{collection}/{object_id}/subscriptions
Add subscriptions
addSubscriptionsForObject 2 params body → 200

Schemas 37

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

DiscordIncomingWebhookConnection
object
Discord incoming webhook connection.
1 property 1 required
InlineChannelDataRequest
object
A request to set channel data for a type of channel inline.
PushChannelDataTokensOnly
object
Push channel data.
1 property 1 required
OneSignalChannelDataPlayerIdsOnly
object
OneSignal channel data.
1 property 1 required
DiscordChannelConnection
object
Discord channel connection.
1 property 1 required
PreferenceSetRequest
object
A request to set a preference set for a recipient.
6 properties
PreferenceSetWorkflowCategorySetting
object
Workflow or category preferences within a preference set
SlackTokenConnection
object
A Slack connection token.
3 properties
PushChannelDataDevicesOnly
object
Push channel data.
1 property 1 required
Object
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
6 properties 4 required
UpsertSubscriptionsRequest
object
A request to upsert subscriptions for a set of recipients.
2 properties 1 required
MsTeamsTokenConnection
object
Microsoft Teams token connection.
4 properties
InlineIdentifyObjectRequest
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
6 properties 2 required
DiscordChannelData
object
Discord channel data.
1 property 1 required
SlackChannelData
object
Slack channel data.
2 properties 1 required
PreferenceSetChannels
object
Channel preferences.
SubscriptionsResponse
array
A response containing a list of subscriptions.
AWSSNSPushChannelDataDevicesOnly
object
AWS SNS push channel data.
1 property 1 required
AWSSNSPushChannelDataTargetARNsOnly
object
AWS SNS push channel data.
1 property 1 required
InlineIdentifyUserRequest
object
A set of parameters to inline-identify a user with. Inline identifying the user will ensure that the user is available before the request is executed in Knock.…
10 properties 1 required
PreferenceSetChannelTypes
object
Channel type preferences.
6 properties
ObjectReference
object
A reference to a recipient object.
2 properties
MsTeamsChannelData
object
Microsoft Teams channel data.
2 properties 1 required
DeleteSubscriptionsRequest
object
A request to delete subscriptions for a set of recipients.
1 property 1 required
SlackIncomingWebhookConnection
object
A Slack connection incoming webhook.
1 property 1 required
ListSubscriptionsResponse
object
A response containing a list of subscriptions.
2 properties 2 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
Subscription
object
A subscription object.
6 properties 5 required
RecipientRequest
Specifies a recipient in a request. This can either be a user identifier (string), an inline user request (object), or an inline object request, which is deter…
PageInfo
object
Pagination information for a list of resources.
4 properties 2 required
MsTeamsIncomingWebhookConnection
object
Microsoft Teams incoming webhook connection.
1 property 1 required
Condition
object
A condition to be evaluated.
3 properties 3 required
PreferenceSetChannelTypeSetting
object
A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
1 property 1 required
RecipientReference
A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).
PreferenceSetChannelSetting
object
A set of settings for a specific channel. Currently, this can only be a list of conditions to apply.
1 property 1 required
Recipient
object
A recipient of a notification, which is either a user or an object.
InlinePreferenceSetRequest
object
Inline set preferences for a recipient, where the key is the preference set id. Preferences that are set inline will be merged into any existing preferences ra…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-subscriptions-api-openapi.yml Raw ↑

Other APIs Knock publishes across the network.

Knock Audiences API
Knock Bulk operations API
Knock Channel data API
Knock Feeds API
Knock Guides API
Knock Integrations API
Knock Messages API
Knock Objects API
Knock Providers API
Knock Schedules API
Knock Tenants API
Knock Users API
Where this information came from

This is an independent, third-party profile of Knock Subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.