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

The Subscriptions API from Knock — 4 operation(s) for subscriptions.

Knock Subscriptions API is one of 35 APIs that Knock publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 6 operations across 4 paths, and defines 40 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.

6 operations 4 paths 40 schemas 1 DELETE2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Server
https://api.knock.app
Authentication
HTTP Bearer
Contact
License
Proprietary
Resource Areas
1

Authentication & Security 1

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

  • BearerAuth — Knock API key as a Bearer token. Use a public key (pk...) for client-side requests or a secret key (sk...) for server-side.

Paths & Operations 6

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

Subscriptions 6
POST
/v1/objects/{collection}/bulk/subscriptions/add
Bulk add subscriptions
bulkAddSubscriptions 1 param body → 200
POST
/v1/objects/{collection}/bulk/subscriptions/delete
Bulk delete subscriptions
bulkDeleteSubscriptions 1 param body → 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
GET
/v1/users/{user_id}/subscriptions
List user subscriptions
listSubscriptionsForUser 6 params → 200

Schemas 40

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

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
MsTeamsTokenConnection
object
Microsoft Teams token connection.
4 properties
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
DeleteSubscriptionsRequest
object
A request to delete subscriptions for a set of recipients.
1 property 1 required
PreferenceSetChannels
object
Channel preferences.
PreferenceSetWorkflowCategorySetting
object
Workflow or category preferences within a preference set
OneSignalChannelDataPlayerIdsOnly
object
OneSignal channel data.
1 property 1 required
BulkUpsertSubscriptionsRequest
object
A request to upsert subscriptions for many groups of 1 subscribed-to object, N subscriber recipients.
1 property 1 required
ObjectReference
object
A reference to a recipient object.
2 properties
DiscordChannelConnection
object
Discord channel connection.
1 property 1 required
Condition
object
A condition to be evaluated.
3 properties 3 required
PushChannelDataDevicesOnly
object
Push channel data.
1 property 1 required
DiscordIncomingWebhookConnection
object
Discord incoming webhook connection.
1 property 1 required
MsTeamsIncomingWebhookConnection
object
Microsoft Teams incoming webhook connection.
1 property 1 required
AWSSNSPushChannelDataDevicesOnly
object
AWS SNS push channel data.
1 property 1 required
SlackIncomingWebhookConnection
object
A Slack connection incoming webhook.
1 property 1 required
SlackTokenConnection
object
A Slack connection token.
3 properties
BulkDeleteSubscriptionsRequest
object
A request to delete subscriptions for many groups of 1 subscribed-to object, N subscriber recipients.
1 property 1 required
PreferenceSetChannelTypes
object
Channel type preferences.
6 properties
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
MsTeamsChannelData
object
Microsoft Teams channel data.
2 properties 1 required
InlineIdentifyObjectRequest
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
6 properties 2 required
SlackChannelData
object
Slack channel data.
2 properties 1 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…
Subscription
object
A subscription object.
6 properties 5 required
DiscordChannelData
object
Discord channel data.
1 property 1 required
PreferenceSetRequest
object
A request to set a preference set for a recipient.
6 properties
ListSubscriptionsResponse
object
A response containing a list of subscriptions.
2 properties 2 required
AWSSNSPushChannelDataTargetARNsOnly
object
AWS SNS push channel data.
1 property 1 required
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…
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
UpsertSubscriptionsRequest
object
A request to upsert subscriptions for a set of recipients.
2 properties 1 required
BulkOperation
object
A bulk operation entity.
15 properties 9 required
SubscriptionsResponse
array
A response containing a list of subscriptions.
PageInfo
object
Pagination information for a list of resources.
4 properties 2 required
PushChannelDataTokensOnly
object
Push channel data.
1 property 1 required
Recipient
object
A recipient of a notification, which is either a user or an object.
InlineChannelDataRequest
object
A request to set channel data for a type of channel inline.
RecipientReference
A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).
Object
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-app-subscriptions-api-openapi.yml Raw ↑

Other APIs Knock publishes across the network.

Knock Outbound Webhooks
Knock Accounts API
Knock API keys API
Knock Audiences API
Knock Branches API
Knock Broadcasts API
Knock Bulk operations API
Knock Channel data API
Knock Channel Groups API
Knock Channels API
Knock Commits API
Knock Email layouts 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.