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 data API

Channel data is data that is specific to a recipient and a channel, like push tokens, or one or more Slack connections.

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

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

6 operations 2 paths 18 schemas 2 DELETE2 GET2 PUT

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

Paths & Operations 6

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

Channel data 6

Channel data is data that is specific to a recipient and a channel, like push tokens, or one or more Slack connections.

DELETE
/v1/users/{user_id}/channel_data/{channel_id}
Unset channel data
unsetUserChannelData 2 params → 204
GET
/v1/users/{user_id}/channel_data/{channel_id}
Get channel data
getUserChannelData 2 params → 200
PUT
/v1/users/{user_id}/channel_data/{channel_id}
Set channel data
setUserChannelData 2 params body → 200
DELETE
/v1/objects/{collection}/{object_id}/channel_data/{channel_id}
Unset channel data
unsetObjectChannelData 3 params → 204
GET
/v1/objects/{collection}/{object_id}/channel_data/{channel_id}
Get channel data
getObjectChannelData 3 params → 200
PUT
/v1/objects/{collection}/{object_id}/channel_data/{channel_id}
Set channel data
setObjectChannelData 3 params body → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are MsTeamsTokenConnection (4 properties), ChannelData (4 properties), SlackTokenConnection (3 properties), PushChannelDataFull (2 properties). Each schema is shown below with its type and property counts.

MsTeamsTokenConnection
object
Microsoft Teams token connection.
4 properties
PushChannelDataDevicesOnly
object
Push channel data.
1 property 1 required
PushChannelDataTokensOnly
object
Push channel data.
1 property 1 required
MsTeamsIncomingWebhookConnection
object
Microsoft Teams incoming webhook connection.
1 property 1 required
OneSignalChannelDataPlayerIdsOnly
object
OneSignal channel data.
1 property 1 required
DiscordChannelData
object
Discord channel data.
1 property 1 required
DiscordChannelConnection
object
Discord channel connection.
1 property 1 required
DiscordIncomingWebhookConnection
object
Discord incoming webhook connection.
1 property 1 required
ChannelDataRequest
object
A request to set channel data for a type of channel.
1 property 1 required
AWSSNSPushChannelDataDevicesOnly
object
AWS SNS push channel data.
1 property 1 required
SlackTokenConnection
object
A Slack connection token.
3 properties
AWSSNSPushChannelDataFull
object
AWS SNS push channel data.
2 properties 2 required
AWSSNSPushChannelDataTargetARNsOnly
object
AWS SNS push channel data.
1 property 1 required
SlackIncomingWebhookConnection
object
A Slack connection incoming webhook.
1 property 1 required
SlackChannelData
object
Slack channel data.
2 properties 1 required
ChannelData
object
Channel data for a given channel type.
4 properties 3 required
PushChannelDataFull
object
Push channel data.
2 properties 2 required
MsTeamsChannelData
object
Microsoft Teams channel data.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-channel-data-api-openapi.yml Raw ↑

Other APIs Knock publishes across the network.

Knock Audiences API
Knock Bulk operations 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
Knock Slack API