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 recipient runs API

The Workflow recipient runs API from Knock — 2 operation(s) for workflow recipient runs.

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

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

2 operations 2 paths 7 schemas 2 GET

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 Workflow recipient runs 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 2

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

Workflow recipient runs 2
GET
/v1/workflow_recipient_runs/{id}
Get a workflow recipient run
getWorkflowRecipientRun 1 param → 200
GET
/v1/workflow_recipient_runs
List workflow recipient runs
listWorkflowRecipientRuns 10 params → 200

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), WorkflowRecipientRunTriggerSource (4 properties), PageInfo (4 properties). Each schema is shown below with its type and property counts.

WorkflowRecipientRun
object
A workflow recipient run represents an individual execution of a workflow for a specific recipient.
12 properties 9 required
WorkflowRecipientRunEvent
object
An event that occurred during a workflow recipient run.
9 properties 5 required
PageInfo
object
Pagination information for a list of resources.
4 properties 2 required
WorkflowRecipientRunDetail
A single workflow recipient run with its events.
ListWorkflowRecipientRunsResponse
object
A paginated list of workflow recipient runs.
2 properties 2 required
WorkflowRecipientRunTriggerSource
object
Describes how the workflow was triggered.
4 properties 1 required
RecipientReference
A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-app-workflow-recipient-runs-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