Knock Messages API is one of 19 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 Messages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.
This API exposes
27 operations
across 24 paths,
and defines 29 schemas.
It is described by OpenAPI 3.0.0, at version 1.0.
Requests are made against a single base URL, https://api.knock.app.
27 operations24 paths29 schemas6 DELETE9 GET8 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://api.knock.app/v1
Authentication
HTTP Bearer
Resource Areas
1
Authentication & Security 1
Knock Messages API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (BearerAuth).
By default, every request must be authenticated.
Paths & Operations 27
Across 24 paths, the API surfaces 27 operations — 6 DELETE, 9 GET, 8 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Messages 27
A message sent to a single recipient on a channel.
GET
/v1/messages/{message_id}/delivery_logs
List delivery logs
listMessageDeliveryLogs4 params→ 200
GET
/v1/messages
List messages
listMessages17 params→ 200
DELETE
/v1/messages/{message_id}/unseen
Mark message as unseen
markMessageUnseen (2)1 param→ 200
POST
/v1/messages/batch/unarchived
Mark messages as unarchived
batchMarkMessagesAsUnarchivedbody→ 200
DELETE
/v1/messages/{message_id}/unread
Mark message as unread
markMessageUnread (2)1 param→ 200
DELETE
/v1/messages/{message_id}/seen
Mark message as unseen
markMessageUnseen1 param→ 200
PUT
/v1/messages/{message_id}/seen
Mark message as seen
markMessageSeen1 param→ 200
GET
/v1/messages/{message_id}/events
List events
listMessageEvents4 params→ 200
POST
/v1/messages/batch/seen
Mark messages as seen
batchMarkMessagesAsSeenbody→ 200
POST
/v1/messages/batch/unseen
Mark messages as unseen
batchMarkMessagesAsUnseenbody→ 200
GET
/v1/objects/{collection}/{id}/messages
List messages
listMessagesForObject19 params→ 200
DELETE
/v1/messages/{message_id}/read
Mark message as unread
markMessageUnread1 param→ 200
PUT
/v1/messages/{message_id}/read
Mark message as read
markMessageRead1 param→ 200
GET
/v1/messages/batch/content
Batch get message contents
batchGetMessageContents1 param→ 200
GET
/v1/messages/{message_id}/content
Get message content
getMessageContents1 param→ 200
GET
/v1/messages/{message_id}/activities
List activities
listMessageActivities5 params→ 200
POST
/v1/channels/{channel_id}/messages/bulk/{action}
Bulk update message statuses for channel
bulkUpdateMessagesForChannel2 paramsbody→ 200
POST
/v1/messages/batch/unread
Mark messages as unread
batchMarkMessagesAsUnreadbody→ 200
DELETE
/v1/messages/{message_id}/archived
Unarchive message
unarchiveMessage (2)1 param→ 200
PUT
/v1/messages/{message_id}/archived
Archive message
archiveMessage1 param→ 200
POST
/v1/messages/batch/archived
Mark messages as archived
batchMarkMessagesAsArchivedbody→ 200
GET
/v1/users/{user_id}/messages
List user messages
listMessagesForUser18 params→ 200
PUT
/v1/messages/{message_id}/interacted
Mark message as interacted
markMessageInteracted1 parambody→ 200
DELETE
/v1/messages/{message_id}/unarchived
Unarchive message
unarchiveMessage1 param→ 200
POST
/v1/messages/batch/read
Mark messages as read
batchMarkMessagesAsReadbody→ 200
GET
/v1/messages/{message_id}
Get message
getMessage1 param→ 200
POST
/v1/messages/batch/interacted
Mark messages as interacted
batchMarkMessagesAsInteractedbody→ 200
Schemas 29
The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Message (22 properties), BulkOperation (15 properties), BulkUpdateMessagesForChannelRequest (10 properties), User (9 properties). Each schema is shown below with its type and property counts.
BatchMessagesStatusRequest
object
Request to update the status of multiple messages in batch.
1 property1 required
RecipientReference
A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).
MessageInteractedRequest
object
A request to mark a message as interacted with.
1 property
MessageInAppFeedContentBlock
object
A block in a message in an app feed.
4 properties4 required
MessageContents
object
The content of a message.
4 properties4 required
MessageSmsContent
object
The content of an SMS message.
3 properties3 required
PageInfo
object
Pagination information for a list of resources.
4 properties2 required
Object
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
6 properties4 required
ListActivitiesResponse
object
Returns a paginated list of activities associated with a given message. For messages produced after a [batch step](/designing-workflows/batch-function), this w…
2 properties2 required
Recipient
object
A recipient of a notification, which is either a user or an object.
MessageDeliveryLogResponse
object
A message delivery log response.
3 properties
ListMessagesResponse
object
A paginated list of messages.
2 properties2 required
Message
object
Represents a single message that was generated by a workflow for a given channel.
22 properties9 required
MessageEmailContent
object
The content of an email message.
9 properties6 required
BatchMessagesInteractedRequest
object
A request to batch mark messages as interacted with.
2 properties1 required
Block
object
A block in a message in a chat.
3 properties3 required
MessageChatContent
object
The content of a chat message.
4 properties3 required
MessageDeliveryLogRequest
object
A message delivery log request.
6 properties
ListMessageEventsResponse
object
Returns a paginated list of [delivery and engagement](/send-notifications/message-statuses) events for the specified message.
2 properties2 required
BulkOperation
object
A bulk operation entity.
15 properties9 required
MessageInAppFeedButtonSetBlock
object
A button set block in a message in an app feed.
3 properties3 required
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
MessageInAppFeedContent
object
The content of an in-app feed message.
2 properties2 required
MessagePushContent
object
Push channel data.
5 properties4 required
MessageEvent
object
A message event. Occurs when a message [delivery or engagement status](/send-notifications/message-statuses) changes.
6 properties5 required
Activity
object
An activity associated with a workflow trigger request. Messages produced after a [batch step](/designing-workflows/batch-function) can be associated with one…
7 properties
MessageDeliveryLog
object
A message delivery log contains a request from Knock to a downstream provider and the response that was returned.
7 properties7 required
BulkUpdateMessagesForChannelRequest
object
Updates message statuses in a specified channel. Use the channelid parameter to target the channel and the status parameter to define what the status should be…
10 properties
ListMessageDeliveryLogsResponse
object
A message delivery log response.
2 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
