Knock Schedules 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 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Schedules 6
GET
/v1/objects/{collection}/{id}/schedules
List object schedules
listObjectSchedules7 params→ 200
DELETE
/v1/schedules
Delete schedules
deleteSchedulesbody→ 200
GET
/v1/schedules
List schedules
listSchedules6 params→ 200
POST
/v1/schedules
Create schedules
createSchedulesbody→ 200
PUT
/v1/schedules
Update schedules
updateSchedulesbody→ 200
GET
/v1/users/{user_id}/schedules
List user schedules
listUserSchedules6 params→ 200
Schemas 40
The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are Schedule (12 properties), InlineIdentifyUserRequest (10 properties), User (9 properties), CreateSchedulesRequest (8 properties). Each schema is shown below with its type and property counts.
DeleteSchedulesRequest
object
A request to delete a schedule.
1 property1 required
SlackTokenConnection
object
A Slack connection token.
3 properties
TenantRequest
object
A tenant to be set in the system. You can supply any additional properties on the tenant object.
5 properties1 required
PushChannelDataTokensOnly
object
Push channel data.
1 property1 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 properties3 required
PreferenceSetChannels
object
Channel preferences.
InlineIdentifyObjectRequest
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
6 properties2 required
SlackIncomingWebhookConnection
object
A Slack connection incoming webhook.
1 property1 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 properties2 required
PushChannelDataDevicesOnly
object
Push channel data.
1 property1 required
Schedule
object
A schedule represents a recurring workflow execution.
12 properties6 required
DiscordChannelData
object
Discord channel data.
1 property1 required
MsTeamsChannelData
object
Microsoft Teams channel data.
2 properties1 required
SlackChannelData
object
Slack channel data.
2 properties1 required
PreferenceSetChannelTypeSetting
object
A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
1 property1 required
CreateSchedulesRequest
object
A request to create a schedule.
8 properties2 required
Condition
object
A condition to be evaluated.
3 properties3 required
Object
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
6 properties4 required
PageInfo
object
Pagination information for a list of resources.
4 properties2 required
SchedulesResponse
array
A list of schedules.
AWSSNSPushChannelDataTargetARNsOnly
object
AWS SNS push channel data.
1 property1 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 property1 required
Recipient
object
A recipient of a notification, which is either a user or an object.
UpdateSchedulesRequest
object
A request to update a schedule.
7 properties1 required
DiscordIncomingWebhookConnection
object
Discord incoming webhook connection.
1 property1 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 properties1 required
AWSSNSPushChannelDataDevicesOnly
object
AWS SNS push channel data.
1 property1 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…
ScheduleRepeatRule
object
The repeat rule for the schedule.
7 properties1 required
OneSignalChannelDataPlayerIdsOnly
object
OneSignal channel data.
1 property1 required
DiscordChannelConnection
object
Discord channel connection.
1 property1 required
InlineTenantRequest
An request to set a tenant inline.
MsTeamsIncomingWebhookConnection
object
Microsoft Teams incoming webhook connection.
1 property1 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.
