Knock

Knock Workflows API

Workflows let you express your cross-channel notification logic.

GitHub OpenAPI

Operations 9

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/workflows/{workflow_key}/validate Validate a workflow without saving · Validate a workflow #
Ask an LLM
“Can I check a workflow definition for errors before saving it?”
“Is there a dry run for workflow payloads?”
Tell an agent
Validate workflow payload {workflow} for {workflow_key} in {environment}.
Check workflow {workflow_key} definition {workflow} without persisting it in {environment}.
PUT /v1/workflows/{workflow_key}/run Run a committed workflow in an environment · Run a workflow #
Ask an LLM
“How do I run the latest committed version of a workflow in a chosen environment?”
“Can I run a workflow on a specific branch for testing?”
Tell an agent
Run workflow {workflow_key} in {environment} for {recipients}.
Run committed workflow {workflow_key} on branch {branch} in {environment} for {recipients}.
POST /v1/workflows/{workflow_key}/steps/{step_ref}/preview_template Preview a workflow step's template · Preview a workflow template #
Ask an LLM
“How do I see what a workflow step's message will look like for a recipient?”
“Can I render a channel step's template with sample data?”
Tell an agent
Preview step {step_ref} of workflow {workflow_key} for {recipient} in {environment}.
Render workflow {workflow_key} step {step_ref} for {recipient} with data {data} in {environment}.
GET /v1/workflows List workflows · List workflows #
Ask an LLM
“Which workflows are defined in this environment?”
“In what order are workflows listed?”
Tell an agent
List workflows in {environment}.
Show {limit} workflows on branch {branch} in {environment}.
PUT /v1/workflows/{workflow_key}/activate Activate or deactivate a workflow · Activate a workflow #
Ask an LLM
“How do I turn a workflow off in production?”
“Does activating a workflow take effect immediately?”
Tell an agent
Set workflow {workflow_key} status to {status} in {environment}.
Activate the {workflow_key} workflow in {environment} with status {status}.
GET /v1/workflows/{workflow_key} Get a workflow by key · Get a workflow #
Ask an LLM
“How do I see a workflow's steps and settings?”
“Can I fetch a workflow without its uncommitted changes?”
Tell an agent
Get workflow {workflow_key} in {environment}.
Show the {workflow_key} workflow definition.
PUT /v1/workflows/{workflow_key} Create or update a workflow · Upsert a workflow #
Ask an LLM
“How do I create a new notification workflow in development?”
“Can I commit a workflow change as I save it?”
Tell an agent
Upsert workflow {workflow_key} in {environment} with {workflow}.
Save workflow {workflow_key} and commit with message {commit_message} in {environment}.
POST /v1/workflows/{key}/trigger Trigger a workflow by key · Trigger workflow #
Ask an LLM
“How do I send a notification by triggering a workflow for some users?”
“Can I pass a cancellation key when triggering so I can cancel later?”
Tell an agent
Trigger workflow {key} for {recipients}.
Trigger workflow {key} for {recipients} with data {data} and cancellation key {cancellation_key}.
POST /v1/workflows/{key}/cancel Cancel queued runs of a workflow · Cancel workflow #
Ask an LLM
“How do I cancel a delayed notification before it sends?”
“Can I cancel a workflow run for only certain recipients?”
Tell an agent destructive · confirm first
Cancel workflow {key} runs with cancellation key {cancellation_key}.
Cancel workflow {key} for {recipients} using cancellation key {cancellation_key}.

Documentation

📖
Documentation
https://docs.knock.app/api-reference/workflows
📖
Documentation
https://docs.knock.app/send-notifications/triggering-workflows/api
📖
Documentation
https://docs.knock.app/api-reference/users
📖
Documentation
https://docs.knock.app/api-reference/messages
📖
Documentation
https://docs.knock.app/api-reference/objects
📖
Documentation
https://docs.knock.app/api-reference/tenants
📖
Documentation
https://docs.knock.app/api-reference/schedules
📖
Documentation
https://docs.knock.app/concepts/schedules
📖
Documentation
https://docs.knock.app/api-reference/audiences
📖
Documentation
https://docs.knock.app/api-reference/channels
📖
Documentation
https://docs.knock.app/api-reference/providers
📖
Documentation
https://docs.knock.app/api-reference/integrations
📖
Documentation
https://docs.knock.app/api-reference/bulk_operations
📖
Documentation
https://docs.knock.app/mapi
📖
Documentation
https://docs.knock.app/developer-tools/management-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/knock-app/refs/heads/main/openapi/knock-app-workflows-api-openapi.yml

Schemas & Data

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

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/knock-app/refs/heads/main/examples/knock-trigger-workflow-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/knock-app/refs/heads/main/examples/knock-identify-user-example.json
🔗
Examples
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-workflows-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

knock-app-workflows-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Knock App Workflows API
  version: '1.0'
  contact:
    name: Knock
    url: https://knock.app
  description: 'Operations tagged Workflows across 2 of this provider''s published API definitions: knock-management-api-openapi.yml, knock-workflows-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://control.knock.app
  variables: {}
- url: https://api.knock.app
  variables: {}
security:
- BearerAuth: []
tags:


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