Knock

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.

Documentation GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

PUT /v1/message_types/{message_type_key}/validate Validate a message type without saving · Validate message type #

Ask an LLM

“Can I check a message type payload for errors before saving it?”

“Is there a dry run for message type definitions?”

Tell an agent

Validate message type payload {message_type} for {message_type_key} in {environment}.

Check message type {message_type_key} definition {message_type} without persisting it in {environment}.

GET /v1/message_types/{message_type_key} Get a message type by key · Get message type #

Ask an LLM

“How do I see one message type's schema and variants?”

“Can I fetch a message type as it is on a branch?”

Tell an agent

Get message type {message_type_key} in {environment}.

Show the {message_type_key} message type.

PUT /v1/message_types/{message_type_key} Create or update a message type · Upsert message type #

Ask an LLM

“How do I create a custom in-app message type?”

“Can I commit a message type change when I save it?”

Tell an agent

Upsert message type {message_type_key} in {environment} with {message_type}.

Save message type {message_type_key} and commit with message {commit_message} in {environment}.

GET /v1/message_types List message types · List message types #

Ask an LLM

“Which message types are defined in this environment?”

“Can I page through message types on a branch?”

Tell an agent

List message types in {environment}.

Show {limit} message types on branch {branch} in {environment}.

Documentation

https://docs.knock.app/api-reference/workflows

https://docs.knock.app/send-notifications/triggering-workflows/api

https://docs.knock.app/api-reference/users

https://docs.knock.app/api-reference/messages

https://docs.knock.app/api-reference/objects

https://docs.knock.app/api-reference/tenants

https://docs.knock.app/api-reference/schedules

https://docs.knock.app/concepts/schedules

https://docs.knock.app/api-reference/audiences

https://docs.knock.app/api-reference/channels

https://docs.knock.app/api-reference/providers

https://docs.knock.app/api-reference/integrations

https://docs.knock.app/api-reference/bulk_operations

https://docs.knock.app/mapi

https://docs.knock.app/developer-tools/management-api

Specifications

https://raw.githubusercontent.com/api-evangelist/knock-app/refs/heads/main/openapi/knock-app-message-types-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/knock-app/refs/heads/main/json-schema/knock-workflow-trigger-schema.json

https://raw.githubusercontent.com/api-evangelist/knock-app/refs/heads/main/json-schema/knock-message-schema.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/knock-app/refs/heads/main/examples/knock-trigger-workflow-example.json

https://raw.githubusercontent.com/api-evangelist/knock-app/refs/heads/main/examples/knock-identify-user-example.json

https://raw.githubusercontent.com/api-evangelist/knock-app/refs/heads/main/examples/knock-create-schedule-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/knock-app:knock-app-message-types-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Knock Management API (mAPI) Message types API
  version: '1.0'
  description: Knock Management API (mAPI) — the resource-management surface for Knock. Programmatic CRUD over Workflows, Channels, Email Layouts, Partials, Templates, Translations, Audiences, Broadcasts, Guides, Message Types, Variables, Members, Channel Groups, Environments, Branches, Commits, and API Keys. Distinct from the runtime Knock API (api.knock.app) — mAPI lives at control.knock.app and is what powers the Knock CLI and MCP server.
  contact:
    name: Knock
    url: https://knock.app
servers:
- url: https://control.knock.app
  variables: {}
security:
- BearerAuth: []
tags:


# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/knock-app/refs/heads/main/openapi/knock-app-message-types-api-openapi.yml