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 Subscriptions. 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.0.3, at version 1.0.
Requests are made against a single base URL, https://api.knock.app.
The identity and technical contract details declared by the specification.
SlackTokenConnection
object
A Slack connection token.
3 properties
BulkUpsertSubscriptionsRequest
object
A request to upsert subscriptions for many groups of 1 subscribed-to object, N subscriber recipients.
1 property
1 required
SubscriptionsResponse
array
A response containing a list of subscriptions.
PushChannelDataTokensOnly
object
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…
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
ListSubscriptionsResponse
object
A response containing a list of subscriptions.
2 properties
2 required
BulkDeleteSubscriptionsRequest
object
A request to delete subscriptions for many groups of 1 subscribed-to object, N subscriber recipients.
1 property
1 required
DeleteSubscriptionsRequest
object
A request to delete subscriptions for a set of recipients.
1 property
1 required
PreferenceSetChannels
object
Channel preferences.
InlineIdentifyObjectRequest
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
6 properties
2 required
SlackIncomingWebhookConnection
object
A Slack connection incoming webhook.
1 property
1 required
InlineChannelDataRequest
object
A request to set channel data for a type of channel inline.
PushChannelDataDevicesOnly
object
Push channel data.
1 property
1 required
DiscordChannelData
object
Discord channel data.
1 property
1 required
MsTeamsChannelData
object
Microsoft Teams channel data.
2 properties
1 required
SlackChannelData
object
Slack channel data.
2 properties
1 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
Condition
object
A condition to be evaluated.
3 properties
3 required
Object
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
6 properties
4 required
PageInfo
object
Pagination information for a list of resources.
4 properties
2 required
AWSSNSPushChannelDataTargetARNsOnly
object
AWS SNS push channel data.
1 property
1 required
PreferenceSetChannelTypes
object
Channel type preferences.
6 properties
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.
DiscordIncomingWebhookConnection
object
Discord incoming webhook connection.
1 property
1 required
UpsertSubscriptionsRequest
object
A request to upsert subscriptions for a set of recipients.
2 properties
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
ObjectReference
object
A reference to a recipient object.
2 properties
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…
AWSSNSPushChannelDataDevicesOnly
object
AWS SNS push channel data.
1 property
1 required
Subscription
object
A subscription object.
6 properties
5 required
OneSignalChannelDataPlayerIdsOnly
object
OneSignal channel data.
1 property
1 required
DiscordChannelConnection
object
Discord channel connection.
1 property
1 required
MsTeamsIncomingWebhookConnection
object
Microsoft Teams incoming webhook connection.
1 property
1 required
BulkOperation
object
A bulk operation entity.
15 properties
9 required
PreferenceSetWorkflowCategorySetting
object
Workflow or category preferences within a preference set
PreferenceSetRequest
object
A request to set a preference set for a recipient.
6 properties
MsTeamsTokenConnection
object
Microsoft Teams token connection.
4 properties
RecipientReference
A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Knock publishes across the network.
