Knock Workflow recipient runs API
A workflow run represents an individual execution of a workflow for a specific recipient.
Knock Workflow recipient runs 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 recipient runs. 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 7 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Knock Workflow recipient runs 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 GET. Each is listed below with its method, path, parameters, and response codes.
A workflow run represents an individual execution of a workflow for a specific recipient.
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are WorkflowRecipientRun (12 properties), WorkflowRecipientRunEvent (9 properties), PageInfo (4 properties), WorkflowRecipientRunTriggerSource (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Knock 12
Other APIs Knock publishes across the network.