Knock Objects API
The Objects API from Knock — 19 operation(s) for objects.
Knock Objects 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 Objects. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.
This API exposes 27 operations across 19 paths, and defines 58 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.
27 operations
19 paths
58 schemas
4 DELETE8 GET6 POST9 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Knock Objects 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 27
Across 19 paths, the API surfaces 27 operations — 4 DELETE, 8 GET, 6 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.
Objects 27
PUT
/v1/objects/{collection}/{object_id}/preferences/{id}/workflowsdeprecated
Update workflows in preference set
PUT
/v1/objects/{collection}/{object_id}/preferences/{id}/channel_types/{type}deprecated
Update a channel type preference
POST
/v1/objects/{collection}/bulk/delete
Bulk delete objects
GET
/v1/objects/{collection}/{id}/schedules
List object schedules
GET
/v1/objects/{collection}/{id}/messages
List messages
PUT
/v1/objects/{collection}/{object_id}/preferences/{id}/categories/{key}deprecated
Update a category preference
GET
/v1/objects/{collection}/{object_id}/preferences
List preference sets
PUT
/v1/objects/{collection}/{object_id}/preferences/{id}/workflows/{key}deprecated
Update a workflow preference
POST
/v1/objects/{collection}/bulk/subscriptions/add
Bulk add subscriptions
PUT
/v1/objects/{collection}/{object_id}/preferences/{id}/categoriesdeprecated
Update categories in preference set
DELETE
/v1/objects/{collection}/{id}
Delete an object
GET
/v1/objects/{collection}/{id}
Get an object
PUT
/v1/objects/{collection}/{id}
Set an object
DELETE
/v1/objects/{collection}/{object_id}/channel_data/{channel_id}
Unset channel data
GET
/v1/objects/{collection}/{object_id}/channel_data/{channel_id}
Get channel data
PUT
/v1/objects/{collection}/{object_id}/channel_data/{channel_id}
Set channel data
GET
/v1/objects/{collection}
List objects in a collection
PUT
/v1/objects/{collection}/{object_id}/preferences/{id}/channel_typesdeprecated
Update channel types in preference set
POST
/v1/objects/{collection}/bulk/subscriptions/delete
Bulk delete subscriptions
DELETE
/v1/objects/{collection}/{object_id}/preferences/{id}
Delete object preference set
GET
/v1/objects/{collection}/{object_id}/preferences/{id}
Get object preference set
PUT
/v1/objects/{collection}/{object_id}/preferences/{id}
Update a preference set
DELETE
/v1/objects/{collection}/{object_id}/subscriptions
Delete subscriptions
GET
/v1/objects/{collection}/{object_id}/subscriptions
List subscriptions
POST
/v1/objects/{collection}/{object_id}/subscriptions
Add subscriptions
POST
/v1/objects/{collection}/bulk/set
Bulk set objects
POST
/v1/schedules/bulk/create
Create schedules in bulk
Schemas 58
The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are Message (22 properties), BulkOperation (15 properties), Schedule (12 properties), InlineIdentifyUserRequest (10 properties). Each schema is shown below with its type and property counts.
Message
object
Represents a single message that was generated by a workflow for a given channel.
22 properties
9 required
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
TenantRequest
object
A tenant to be set in the system. You can supply any additional properties on the tenant object.
5 properties
1 required
BulkCreateSchedulesRequest
object
A request to bulk create schedules. Accepts a list of schedules to create. Each schedule must have a single recipient. The recipients do not have to be unique.
1 property
1 required
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…
SubscriptionsResponse
array
A response containing a list of subscriptions.
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
ListObjectsResponse
object
A paginated list of objects in a collection.
2 properties
2 required
PushChannelDataFull
object
Push channel data.
2 properties
2 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
ChannelDataRequest
object
A request to set channel data for a type of channel.
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
ListMessagesResponse
object
A paginated list of messages.
2 properties
2 required
AWSSNSPushChannelDataFull
object
AWS SNS push channel data.
2 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.
ListSchedulesResponse
object
A response containing a list of schedules.
2 properties
2 required
PushChannelDataDevicesOnly
object
Push channel data.
1 property
1 required
Schedule
object
A schedule represents a recurring workflow execution.
12 properties
6 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
BulkDeleteObjectsRequest
object
Request body for bulk deleting objects.
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
PreferenceSet
object
A preference set represents a specific set of notification preferences for a recipient. A recipient can have multiple preference sets.
6 properties
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
AWSSNSPushChannelDataDevicesOnly
object
AWS SNS push channel data.
1 property
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…
ScheduleRepeatRule
object
The repeat rule for the schedule.
7 properties
1 required
OneSignalChannelDataPlayerIdsOnly
object
OneSignal channel data.
1 property
1 required
BulkSetObjectsRequest
object
A request to set objects in bulk.
1 property
1 required
ChannelData
object
Channel data for a given channel type.
4 properties
3 required
DiscordChannelConnection
object
Discord channel connection.
1 property
1 required
MsTeamsIncomingWebhookConnection
object
Microsoft Teams incoming webhook connection.
1 property
1 required
SetObjectRequest
object
A set of parameters to set an object with. Does not include the object id or collection.
5 properties
Subscription
object
A subscription object.
6 properties
5 required
InlineTenantRequest
An request to set a tenant inline.
BulkOperation
object
A bulk operation entity.
15 properties
9 required
BulkSetObjectRequest
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
5 properties
1 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).
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Knock 12
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
#Objects