Knock Broadcasts API
The Broadcasts API from Knock — 5 operation(s) for broadcasts.
Knock Broadcasts 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 Broadcasts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.
This API exposes 6 operations across 5 paths, and defines 50 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.
6 operations
5 paths
50 schemas
2 GET4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Knock Broadcasts 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 6
Across 5 paths, the API surfaces 6 operations — 2 GET, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Broadcasts 6
PUT
/v1/broadcasts/{broadcast_key}/send
Send a broadcast
PUT
/v1/broadcasts/{broadcast_key}/validate
Validate a broadcast
GET
/v1/broadcasts
List broadcasts
GET
/v1/broadcasts/{broadcast_key}
Get a broadcast
PUT
/v1/broadcasts/{broadcast_key}
Upsert a broadcast
PUT
/v1/broadcasts/{broadcast_key}/cancel
Cancel a scheduled broadcast
Schemas 50
The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are Broadcast (16 properties), WorkflowSmsStep (11 properties), WorkflowEmailStep (11 properties), WorkflowChatStep (11 properties). Each schema is shown below with its type and property counts.
WorkflowRandomCohortStepBranch
object
A cohort branch in an experiment step.
4 properties
1 required
ConditionGroup
object
A group of conditions to be evaluated.
PushChannelSettings
object
Push channel settings. Only used as configuration as part of a workflow channel step.
1 property
WorkflowChatStep
object
A chat step within a workflow. Read more in the [docs](https://docs.knock.app/designing-workflows/channel-step).
11 properties
3 required
ChatChannelSettings
object
Chat channel settings. Only used as configuration as part of a workflow channel step.
2 properties
EmailChannelSettings
object
Email channel settings. Only used as configuration as part of a workflow channel step.
9 properties
WorkflowFetchStep
object
A fetch function step. Retrieves data from an external source and merges it into the workflow's data scope for use in later steps. Read more in the [docs](http…
6 properties
3 required
EmailButtonSetBlockButton
object
A button in a button set block.
5 properties
3 required
WebhookTemplate
object
A webhook template. By default, a webhook step will use the request settings you configured in your webhook channel. You can override this as you see fit on a…
5 properties
2 required
WorkflowStep
object
A step within a workflow. Each workflow step, regardless of its type, share a common set of core attributes (type, ref, name, description, conditions).
WorkflowInAppFeedStep
object
An in-app feed step within a workflow. Read more in the [docs](https://docs.knock.app/designing-workflows/channel-step).
11 properties
3 required
WorkflowBatchStep
object
A batch function step. Read more in the [docs](https://docs.knock.app/designing-workflows/batch-function).
5 properties
3 required
WorkflowUpdateUserStep
object
An update user step. Updates properties of a specific user referenced in the workflow.
6 properties
3 required
WorkflowWebhookStep
object
A webhook step within a workflow to send an HTTP request to a generic channel. Read more in the [docs](https://docs.knock.app/designing-workflows/channel-step).
10 properties
3 required
SmsChannelSettings
object
SMS channel settings. Only used as configuration as part of a workflow channel step.
1 property
WorkflowUpdateTenantStep
object
An update tenant step. Updates properties of a specific tenant referenced in the workflow.
6 properties
3 required
WorkflowAIAgentStep
object
An AI agent function step. Fetches data from an AI model and merges it into the workflow's data scope for use in later steps. Supports Liquid templating in the…
6 properties
3 required
SmsTemplate
object
An SMS template.
2 properties
1 required
ConditionGroupAnyMatch
object
A group of conditions that any must be met. Can contain nested alls.
1 property
WorkflowSmsStep
object
A SMS step within a workflow. Read more in the [docs](https://docs.knock.app/designing-workflows/channel-step).
11 properties
3 required
Condition
object
A condition to be evaluated.
3 properties
2 required
ConditionGroupAllMatch
object
A group of conditions that must all be met.
1 property
EmailPartialBlock
object
A partial block in an email template, used to render a reusable partial component.
7 properties
4 required
InAppFeedChannelSettings
object
In-app feed channel settings. Only used as configuration as part of a workflow channel step.
1 property
PageInfo
object
The information about a paginated result.
3 properties
1 required
WorkflowUpdateObjectStep
object
An update object step. Updates properties of a specific object referenced in the workflow.
6 properties
3 required
WorkflowTriggerWorkflowStep
object
A workflow trigger function step. Read more in the [docs](https://docs.knock.app/designing-workflows/trigger-workflow-function).
6 properties
3 required
WorkflowBranchStep
object
A branch function step. Read more in the [docs](https://docs.knock.app/designing-workflows/branch-function).
5 properties
3 required
Duration
object
A duration of time, represented as a unit and a value.
2 properties
2 required
InAppFeedTemplate
object
An in-app feed template.
3 properties
1 required
WorkflowDelayStep
object
A delay function step. Read more in the [docs](https://docs.knock.app/designing-workflows/delay-function).
6 properties
3 required
SendWindow
object
A send window time for a notification. Describes a single day.
4 properties
2 required
ChatTemplate
object
A chat template.
3 properties
1 required
EmailDividerBlock
object
A divider block in an email template.
4 properties
1 required
EmailHtmlBlock
object
An HTML block in an email template.
5 properties
2 required
WorkflowUpdateDataStep
object
An update data function step. Merges data into the workflow's data scope for use in subsequent steps.
6 properties
3 required
EmailVisualBlocks
array
The visual blocks that make up the email template.
WorkflowRandomCohortStep
object
An experiment step. Deterministically assigns recipients to percentage-based cohorts for A/B testing and experimentation.
6 properties
3 required
EmailButtonSetBlock
object
A button set block in an email template.
5 properties
2 required
EmailMarkdownBlock
object
A markdown block in an email template.
6 properties
2 required
EmailTemplate
object
An email message template.
6 properties
2 required
WorkflowPushStep
object
A push step within a workflow. Read more in the [docs](https://docs.knock.app/designing-workflows/channel-step).
11 properties
3 required
BroadcastRequest
object
A broadcast request for upserting a broadcast.
7 properties
2 required
PushTemplate
object
A push notification template.
3 properties
3 required
RequestTemplate
object
A request template for a fetch function step.
5 properties
2 required
BroadcastSendRequest
object
A request to send or schedule a broadcast.
1 property
Broadcast
object
A broadcast object.
16 properties
9 required
EmailImageBlock
object
An image block in an email template.
8 properties
2 required
WorkflowThrottleStep
object
A throttle function step. Read more in the [docs](https://docs.knock.app/designing-workflows/throttle-function).
6 properties
3 required
WorkflowEmailStep
object
An email step within a workflow. Read more in the [docs](https://docs.knock.app/designing-workflows/channel-step).
11 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Knock 12
Other APIs Knock publishes across the network.
Knock Outbound Webhooks
Knock Accounts API
Knock API keys API
Knock Audiences API
Knock Branches API
Knock Bulk operations API
Knock Channel data API
Knock Channel Groups API
Knock Channels API
Knock Commits API
Knock Email layouts API
Knock Environments API
#Broadcasts