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 Channel Groups API

The Channel Groups API from Knock — 2 operation(s) for channel groups.

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

This API exposes 4 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.

4 operations 2 paths 7 schemas 1 DELETE2 GET1 PUT

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 Channel Groups 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 4

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

Channel Groups 4
GET
/v1/channel_groups
List channel groups
listChannelGroups 3 params → 200
DELETE
/v1/channel_groups/{channel_group_key}
Delete a channel group
deleteChannelGroup 1 param → 204
GET
/v1/channel_groups/{channel_group_key}
Get a channel group
getChannelGroup 1 param → 200
PUT
/v1/channel_groups/{channel_group_key}
Upsert a channel group
upsertChannelGroup 1 param body → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Channel (11 properties), ChannelGroup (9 properties), ChannelGroupRule (8 properties), ChannelGroupRuleRequest (6 properties). Each schema is shown below with its type and property counts.

Channel
object
A configured channel, which is a way to route messages to a provider.
11 properties 7 required
PageInfo
object
The information about a paginated result.
3 properties 1 required
ChannelGroupRuleRequest
object
A rule that determines if a channel should be executed as part of a channel group.
6 properties 2 required
ChannelGroupRule
object
A rule that determines if a channel should be executed as part of a channel group.
8 properties 5 required
ChannelGroup
object
A group of channels with rules for when they are applicable.
9 properties 8 required
ChannelGroupRequest
object
A request to create or update a channel group.
4 properties 2 required
ChannelEnvironmentSettings
object
Environment-specific settings for a channel.
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-app-channel-groups-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 Channels API
Knock Commits API
Knock Email layouts API
Knock Environments API