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

A provider represents a third-party service that Knock integrates with and is configured via a channel.

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

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

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

Paths & Operations 7

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

Providers 7

A provider represents a third-party service that Knock integrates with and is configured via a channel.

GET
/v1/providers/slack/{channel_id}/channels
List channels
listChannelsForSlackProvider 7 params → 200403
GET
/v1/providers/ms-teams/{channel_id}/auth_check
Check auth
msTeamsProviderAuthCheck 2 params → 200
GET
/v1/providers/slack/{channel_id}/auth_check
Check auth
slackProviderAuthCheck 2 params → 200
GET
/v1/providers/ms-teams/{channel_id}/channels
List channels
listChannelsForMsTeamsProvider 5 params → 200
PUT
/v1/providers/slack/{channel_id}/revoke_access
Revoke access
slackProviderRevokeAccess 2 params → 200403
GET
/v1/providers/ms-teams/{channel_id}/teams
List teams
listTeamsForMsTeamsProvider 6 params → 200
PUT
/v1/providers/ms-teams/{channel_id}/revoke_access
Revoke access
msTeamsProviderRevokeAccess 2 params → 200403

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are TeamsForMsTeamsProviderResponse (2 properties), ChannelsForSlackProviderResponse (2 properties), MsTeamsAuthCheckResponse (1 property), ChannelsForMsTeamsProviderResponse (1 property). Each schema is shown below with its type and property counts.

SlackAuthCheckResponse
object
The response from a Slack auth check request.
1 property 1 required
ChannelsForMsTeamsProviderResponse
object
The response from a Microsoft Teams provider request, containing a list of channels.
1 property 1 required
ChannelsForSlackProviderResponse
object
The response from a Slack provider request, containing a list of channels.
2 properties 2 required
MsTeamsAuthCheckResponse
object
The response from a Microsoft Teams auth check request.
1 property 1 required
TeamsForMsTeamsProviderResponse
object
The response from a Microsoft Teams provider request, containing a list of teams.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-providers-api-openapi.yml Raw ↑

Other APIs Knock publishes across the network.

Knock Audiences API
Knock Bulk operations API
Knock Channel data API
Knock Feeds API
Knock Guides API
Knock Integrations API
Knock Messages API
Knock Microsoft Teams API
Knock Objects API
Knock Preferences API
Knock Schedules API
Knock Slack API