Docs
/
/
Contact supportLog inGet started
Overview
Client libraries
API keys
Authentication
Rate limits
Batch rate limits
Idempotent requests
Data retention
Bulk endpoints
Trigger data filtering
Pagination
Errors
Common error codes
Overview
Set an object
Get an object
List objects in a collection
Delete an object
List preference sets
Get object preference set
Update a preference set
List object schedules
List messages
Get channel data
Set channel data
Unset channel data
List subscriptions
Add subscriptions
Delete subscriptions
Get startedLog inContact support
Platform
Integrations
In-app UI
API reference
CLI reference
Management API
Developer tools
Tutorials

Objects

An [Object](/concepts/objects) represents a resource in your system that you've stored in Knock. It can be used to send out-of-app notifications to non-user recipients (such as a public channel in a chat app), or to trigger notifications to [subscribers](/concepts/subscriptions) of a non-user resource such as a shared document.

An Object represents a resource in your system that you've stored in Knock. It can be used to send out-of-app notifications to non-user recipients (such as a public channel in a chat app), or to trigger notifications to subscribers of a non-user resource such as a shared document.

Endpoints

PUT
/v1/objects/{collection}/{id}Set an object
GET
/v1/objects/{collection}/{id}Get an object
GET
/v1/objects/{collection}List objects in a collection
DELETE
/v1/objects/{collection}/{id}Delete an object
GET
/v1/objects/{collection}/{object_id}/preferencesList preference sets
GET
/v1/objects/{collection}/{object_id}/preferences/{id}Get object preference set
PUT
/v1/objects/{collection}/{object_id}/preferences/{id}Update a preference set
GET
/v1/objects/{collection}/{id}/schedulesList object schedules
GET
/v1/objects/{collection}/{id}/messagesList messages
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
DELETE
/v1/objects/{collection}/{object_id}/channel_data/{channel_id}Unset channel data
GET
/v1/objects/{collection}/{object_id}/subscriptionsList subscriptions
POST
/v1/objects/{collection}/{object_id}/subscriptionsAdd subscriptions
DELETE
/v1/objects/{collection}/{object_id}/subscriptionsDelete subscriptions

Subresources

Bulk operations4 endpoints

Object definitions

Object
InlineIdentifyObjectRequest
New chat