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 Workflow Triggers API

Operations for triggering and canceling workflow executions.

Knock Workflow Triggers 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 Workflow Triggers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

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

2 operations 2 paths 4 schemas 2 POST

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 Workflow Triggers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 2

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

Workflow Triggers 2

Operations for triggering and canceling workflow executions.

POST
/v1/notify/cancel
Cancel workflow
cancelWorkflow (2) body → 204
POST
/v1/notify
Trigger workflow
triggerWorkflow body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Notify Request (5 properties), Cancel Request (3 properties), Notify Response (1 property). Each schema is shown below with its type and property counts.

Notify Response
object
The response from triggering a workflow.
1 property 1 required
RecipientReference
A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).
Cancel Request
object
When invoked using a specific workflow key and cancellation key, will cancel any queued workflow runs associated with that key/cancellation key pair. Can optio…
3 properties 2 required
Notify Request
object
A request to trigger a notification workflow.
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-workflow-triggers-api-openapi.yml Raw ↑

Other APIs Knock publishes across the network.

Knock Audiences API
Knock Bulk operations API
Knock Channel data API
Knock Feeds API
Knock Guides API
Knock Integrations API
Knock Messages API
Knock Microsoft Teams API
Knock Objects API
Knock Preferences API
Knock Providers API
Knock Schedules API