Knock Tenants 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 Tenants. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.
This API exposes
6 operations
across 4 paths,
and defines 33 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 operations4 paths33 schemas1 DELETE2 GET2 POST1 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 Tenants 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 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Tenants 6
A tenant represents a top-level entity from your system, like a company, organization, account, or workspace.
DELETE
/v1/tenants/{id}
Delete a tenant
deleteTenant1 param→ 204
GET
/v1/tenants/{id}
Get a tenant
getTenant2 params→ 200
PUT
/v1/tenants/{id}
Set a tenant
setTenant2 paramsbody→ 200
GET
/v1/tenants
List tenants
listTenants5 params→ 200
POST
/v1/tenants/bulk/delete
Bulk delete tenants
bulkDeleteTenants1 param→ 200
POST
/v1/tenants/bulk/set
Bulk set tenants
bulkSetTenantsbody→ 200
Schemas 33
The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are BulkOperation (15 properties), PreferenceSetRequest (6 properties), PreferenceSet (6 properties), PreferenceSetChannelTypes (6 properties). Each schema is shown below with its type and property counts.
DiscordIncomingWebhookConnection
object
Discord incoming webhook connection.
1 property1 required
TenantRequest
object
A tenant to be set in the system. You can supply any additional properties on the tenant object.
5 properties1 required
Tenant
object
A tenant entity.
4 properties2 required
InlinePreferenceSetRequest
object
Inline set preferences for a recipient, where the key is the preference set id. Preferences that are set inline will be merged into any existing preferences ra…
SetTenantResponse
The response from setting a tenant.
InlineTenantRequest
An request to set a tenant inline.
MsTeamsTokenConnection
object
Microsoft Teams token connection.
4 properties
PageInfo
object
Pagination information for a list of resources.
4 properties2 required
MsTeamsIncomingWebhookConnection
object
Microsoft Teams incoming webhook connection.
1 property1 required
OneSignalChannelDataPlayerIdsOnly
object
OneSignal channel data.
1 property1 required
PreferenceSetWorkflowCategorySetting
object
Workflow or category preferences within a preference set
PreferenceSetChannelTypes
object
Channel type preferences.
6 properties
PreferenceSetChannelTypeSetting
object
A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
1 property1 required
PreferenceSetRequest
object
A request to set a preference set for a recipient.
6 properties
AWSSNSPushChannelDataTargetARNsOnly
object
AWS SNS push channel data.
1 property1 required
SetTenantRequest
object
A tenant to be set in the system. You can supply any additional properties on the tenant object.
3 properties
DiscordChannelConnection
object
Discord channel connection.
1 property1 required
AWSSNSPushChannelDataDevicesOnly
object
AWS SNS push channel data.
1 property1 required
Condition
object
A condition to be evaluated.
3 properties3 required
InlineChannelDataRequest
object
A request to set channel data for a type of channel inline.
BulkOperation
object
A bulk operation entity.
15 properties9 required
BulkSetTenantsRequest
object
A request to set tenants in bulk.
1 property1 required
PushChannelDataTokensOnly
object
Push channel data.
1 property1 required
DiscordChannelData
object
Discord channel data.
1 property1 required
ListTenantsResponse
object
A response containing a list of tenants.
2 properties2 required
SlackTokenConnection
object
A Slack connection token.
3 properties
PreferenceSetChannels
object
Channel preferences.
SlackIncomingWebhookConnection
object
A Slack connection incoming webhook.
1 property1 required
PreferenceSet
object
A preference set represents a specific set of notification preferences for a recipient. A recipient can have multiple preference sets.
6 properties1 required
SlackChannelData
object
Slack channel data.
2 properties1 required
MsTeamsChannelData
object
Microsoft Teams channel data.
2 properties1 required
PreferenceSetChannelSetting
object
A set of settings for a specific channel. Currently, this can only be a list of conditions to apply.
1 property1 required
PushChannelDataDevicesOnly
object
Push channel data.
1 property1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
