Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Knock Message types API

A message type allows you to specify an in-app schema that defines the fields available for your in-app notifications.

Knock Message types 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 Message types. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 4 operations across 3 paths, and defines 14 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.

4 operations 3 paths 14 schemas 2 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Server
https://api.knock.app
Authentication
HTTP Bearer
Contact
License
Proprietary
Resource Areas
1

Authentication & Security 1

Knock Message types 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 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Message types 4

A message type allows you to specify an in-app schema that defines the fields available for your in-app notifications.

PUT
/v1/message_types/{message_type_key}/validate
Validate message type
validateMessageType 3 params body → 200
GET
/v1/message_types/{message_type_key}
Get message type
getMessageType 5 params → 200
PUT
/v1/message_types/{message_type_key}
Upsert message type
upsertMessageType 7 params body → 200
GET
/v1/message_types
List message types
listMessageTypes 7 params → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are MessageType (15 properties), MessageTypeImageField (7 properties), MessageTypeRequest (6 properties), MessageTypeButtonField (6 properties). Each schema is shown below with its type and property counts.

MessageTypeMarkdownField
object
A markdown field used in a message type.
4 properties 3 required
MessageTypeImageField
object
An image field used in a message type.
7 properties 6 required
MessageType
object
A message type is a schema for a message that maps to a UI component or element within your application.
15 properties 11 required
PageInfo
object
The information about a paginated result.
3 properties 1 required
MessageTypeMultiSelectField
object
A multi-select field used in a message type.
4 properties 4 required
MessageTypeRequest
object
A request to create a message type.
6 properties 3 required
MessageTypeVariant
object
A variant of a message type.
3 properties 3 required
MessageTypeBooleanField
object
A boolean field used in a message type.
4 properties 3 required
MessageTypeTextField
object
A text field used in a message type.
4 properties 3 required
MessageTypeJsonField
object
A JSON field used in a message type.
4 properties 3 required
MessageTypeTextareaField
object
A textarea field used in a message type.
4 properties 3 required
MessageTypeSelectField
object
A select field used in a message type.
4 properties 4 required
MessageTypeUrlField
object
A URL field used in a message type.
4 properties 3 required
MessageTypeButtonField
object
A button field used in a message type.
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-app-message-types-api-openapi.yml Raw ↑

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