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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Knock

Knock Objects API

An object represents a resource in your system that you want to map into Knock.

Documentation Provider Profile APIs.io OpenAPI GitHub

Knock Objects 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 Objects. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 19 operations across 15 paths, and defines 42 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.

19 operations 15 paths 42 schemas 2 DELETE4 GET5 POST8 PUT

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 Objects API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 19

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

Objects 19

An object represents a resource in your system that you want to map into Knock.

PUT
/v1/objects/{collection}/{object_id}/preferences/{id}/workflowsdeprecated
Update workflows in preference set
updateObjectPreferenceWorkflows → 200
PUT
/v1/objects/{collection}/{object_id}/preferences/{id}/channel_types/{type}deprecated
Update a channel type preference
updateObjectPreferenceChannelType → 200
POST
/v1/objects/{collection}/bulk/delete
Bulk delete objects
bulkDeleteObjects 1 param body → 200
PUT
/v1/objects/{collection}/{object_id}/preferences/{id}/categories/{key}deprecated
Update a category preference
updateObjectPreferenceCategory → 200
GET
/v1/objects/{collection}/{object_id}/preferences
List preference sets
listObjectPreferenceSets 2 params → 200
PUT
/v1/objects/{collection}/{object_id}/preferences/{id}/workflows/{key}deprecated
Update a workflow preference
updateObjectPreferenceWorkflow → 200
POST
/v1/objects/{collection}/bulk/subscriptions/add
Bulk add subscriptions
bulkAddSubscriptions 1 param body → 200
PUT
/v1/objects/{collection}/{object_id}/preferences/{id}/categoriesdeprecated
Update categories in preference set
updateObjectPreferenceCategories → 200
DELETE
/v1/objects/{collection}/{id}
Delete an object
deleteObject 2 params → 204
GET
/v1/objects/{collection}/{id}
Get an object
getObject 2 params → 200
PUT
/v1/objects/{collection}/{id}
Set an object
setObject 2 params body → 200
GET
/v1/objects/{collection}
List objects in a collection
listObjects 5 params → 200
PUT
/v1/objects/{collection}/{object_id}/preferences/{id}/channel_typesdeprecated
Update channel types in preference set
updateObjectPreferenceChannelTypes → 200
POST
/v1/schedules/bulk/create
Create schedules in bulk
bulkCreateSchedules body → 200
POST
/v1/objects/{collection}/bulk/subscriptions/delete
Bulk delete subscriptions
bulkDeleteSubscriptions 1 param body → 200
DELETE
/v1/objects/{collection}/{object_id}/preferences/{id}
Delete object preference set
deleteObjectPreferenceSet 3 params → 204
GET
/v1/objects/{collection}/{object_id}/preferences/{id}
Get object preference set
getObjectPreferenceSet 3 params → 200
PUT
/v1/objects/{collection}/{object_id}/preferences/{id}
Update a preference set
updateObjectPreferenceSet 3 params body → 200
POST
/v1/objects/{collection}/bulk/set
Bulk set objects
bulkSetObjects 1 param body → 200

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are BulkOperation (15 properties), InlineIdentifyUserRequest (10 properties), ScheduleRepeatRule (7 properties), PreferenceSetRequest (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
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
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
SetObjectRequest
object
A set of parameters to set an object with. Does not include the object id or collection.
5 properties
MsTeamsTokenConnection
object
Microsoft Teams token connection.
4 properties
Object
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
6 properties 4 required
InlineIdentifyObjectRequest
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
6 properties 2 required
BulkSetObjectRequest
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
5 properties 1 required
DiscordChannelData
object
Discord channel data.
1 property 1 required
SlackChannelData
object
Slack channel data.
2 properties 1 required
PreferenceSetChannels
object
Channel preferences.
AWSSNSPushChannelDataDevicesOnly
object
AWS SNS push channel data.
1 property 1 required
BulkDeleteSubscriptionsRequest
object
A request to delete subscriptions for many groups of 1 subscribed-to object, N subscriber recipients.
1 property 1 required
AWSSNSPushChannelDataTargetARNsOnly
object
AWS SNS push 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
InlineTenantRequest
An request to set a tenant inline.
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
MsTeamsChannelData
object
Microsoft Teams channel data.
2 properties 1 required
SlackIncomingWebhookConnection
object
A Slack connection incoming webhook.
1 property 1 required
BulkDeleteObjectsRequest
object
Request body for bulk deleting objects.
1 property 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
ListObjectsResponse
object
A paginated list of objects in a collection.
2 properties 2 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
ScheduleRepeatRule
object
The repeat rule for the schedule.
7 properties 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
TenantRequest
object
A tenant to be set in the system. You can supply any additional properties on the tenant object.
5 properties 1 required
BulkOperation
object
A bulk operation entity.
15 properties 9 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
BulkSetObjectsRequest
object
A request to set objects in bulk.
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…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-objects-api-openapi.yml Raw ↑

Other APIs Knock publishes across the network.

Knock Audiences API
AE Profile APIs.io
Knock Bulk operations API
AE Profile APIs.io
Knock Channel data API
AE Profile APIs.io
Knock Feeds API
AE Profile APIs.io
Knock Guides API
AE Profile APIs.io
Knock Integrations API
AE Profile APIs.io
Knock Messages API
AE Profile APIs.io
Knock Providers API
AE Profile APIs.io
Knock Schedules API
AE Profile APIs.io
Knock Subscriptions API
AE Profile APIs.io
Knock Tenants API
AE Profile APIs.io
Knock Users API
AE Profile APIs.io
#Objects
← Back to K APIs
API Details
ID
knock:knock-objects-api
Base URL
https://api.knock.app/v1
Docs
https://docs.knock.app/reference
Provider
Knock
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=knock-objects-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/knock-objects-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Knock Objects 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.