Providers API reference
Complete reference documentation for the Providers resource.
Providers
#A Provider is a channel-specific configuration that determines how a message is delivered to a recipient.
Slack
#A Slack provider is a channel-specific configuration that determines how a message is delivered to a recipient via Slack.
List channels
#List Slack channels for a Slack workspace.
Endpoint
Path parameters
The ID of the Knock Slack channel to get channels for.
Query parameters
A JSON encoded string containing the access token object reference.
Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection.
The maximum number of channels to return. Defaults to 200.
Set to true to exclude archived channels from the list. Defaults to true when not explicitly provided.
Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im. Defaults to "public_channel,private_channel". If the user's Slack ID is unavailable, this option is ignored and only public channels are returned.
Encoded team ID (T1234) to list channels in, required if org token is used.
Returns
The response from a Slack provider request, containing a list of channels.
Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection.
List of Slack channels.
The team ID that the Slack channel belongs to.
A Slack channel ID from the Slack provider.
Whether the Slack channel is an IM channel.
Whether the Slack channel is private.
Slack channel name.
Authentication error response
The error code.
The error message.
The HTTP status code.
The error type.
Check auth
#Check if a Slack channel is authenticated.
Endpoint
Path parameters
The ID of the Knock Slack channel to check.
Query parameters
A JSON encoded string containing the access token object reference.
Returns
The response from a Slack auth check request.
A Slack connection object.
Whether the Slack connection is valid.
The reason for the Slack connection if it is not valid.
Revoke access
#Revoke access for a Slack channel.
Endpoint
Path parameters
The ID of the Knock Slack channel to revoke access for.
Query parameters
A JSON encoded string containing the access token object reference.
Returns
A response indicating the operation was successful.
OK response.
Authentication error response
The error code.
The error message.
The HTTP status code.
The error type.
Microsoft Teams
#A Microsoft Teams provider is a channel-specific configuration that determines how a message is delivered to a recipient via Microsoft Teams.
List channels
#List the Microsoft Teams channels within a team. By default, archived and private channels are excluded from the results.
Endpoint
Path parameters
The ID of the Knock Microsoft Teams channel to get channels for.
Query parameters
A JSON encoded string containing the Microsoft Teams tenant object reference.
Microsoft Teams team ID.
OData param passed to the Microsoft Graph API to filter channels.
OData param passed to the Microsoft Graph API to select specific properties.
Returns
The response from a Microsoft Teams provider request, containing a list of channels.
List of Microsoft Teams channels.
Microsoft Teams channel created date and time.
Microsoft Teams channel description.
Microsoft Teams channel name.
Microsoft Teams channel ID.
Whether the Microsoft Teams channel is archived.
Microsoft Teams channel membership type.
List teams
#Get a list of teams belonging to the Microsoft Entra tenant. By default, archived and private channels are excluded from the results.
Endpoint
Path parameters
The ID of the Knock Microsoft Teams channel to get teams for.
Query parameters
A JSON encoded string containing the Microsoft Teams tenant object reference.
OData param passed to the Microsoft Graph API to filter teams.
OData param passed to the Microsoft Graph API to select fields on a team.
OData param passed to the Microsoft Graph API to limit the number of teams returned.
OData param passed to the Microsoft Graph API to retrieve the next page of results.
Returns
The response from a Microsoft Teams provider request, containing a list of teams.
List of Microsoft Teams teams.
Microsoft Teams team description.
Microsoft Teams team display name.
Microsoft Teams team ID.
OData param passed to the Microsoft Graph API to retrieve the next page of results.
Check auth
#Check if a connection to Microsoft Teams has been authorized for a given Microsoft Teams tenant object.
Endpoint
Path parameters
The ID of the Knock Microsoft Teams channel to check.
Query parameters
A JSON encoded string containing the Microsoft Teams tenant object reference.
Returns
The response from a Microsoft Teams auth check request.
A Microsoft Teams connection object.
Whether the Microsoft Teams connection is valid.
The reason for the Microsoft Teams connection if it is not valid.
Revoke access
#Remove a Microsoft Entra tenant ID from a Microsoft Teams tenant object.
Endpoint
Path parameters
The ID of the Knock Microsoft Teams channel to revoke access for.
Query parameters
A JSON encoded string containing the Microsoft Teams tenant object reference.
Returns
A response indicating the operation was successful.
OK response.
Authentication error response
The error code.
The error message.
The HTTP status code.
The error type.