Knock Audiences 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 Audiences. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.
This API exposes
3 operations
across 1 path,
and defines 31 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.
3 operations1 paths31 schemas1 DELETE1 GET1 POST
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 Audiences API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (BearerAuth).
By default, every request must be authenticated.
Paths & Operations 3
Across 1 path, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Audiences 3
An Audience is a segment of users.
DELETE
/v1/audiences/{key}/members
Remove members
removeAudienceMembers1 parambody→ 204
GET
/v1/audiences/{key}/members
List members
listAudienceMembers1 param→ 200
POST
/v1/audiences/{key}/members
Add members
addAudienceMembers2 paramsbody→ 204
Schemas 31
The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are InlineIdentifyUserRequest (10 properties), User (9 properties), PreferenceSetChannelTypes (6 properties), PreferenceSetRequest (6 properties). Each schema is shown below with its type and property counts.
DiscordIncomingWebhookConnection
object
Discord incoming webhook connection.
1 property1 required
RemoveAudienceMembersRequest
object
A request to remove a list of audience members.
1 property1 required
AudienceMember
object
An audience member.
5 properties4 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…
AddAudienceMembersRequest
object
A request to add a list of audience members.
1 property1 required
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
DiscordChannelConnection
object
Discord channel connection.
1 property1 required
AudienceMemberRequest
object
An audience member.
2 properties1 required
InlineIdentifyUserRequest
object
A set of parameters to inline-identify a user with. Inline identifying the user will ensure that the user is available before the request is executed in Knock.…
10 properties1 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.
User
object
A [User](/concepts/users) represents an individual in your system who can receive notifications through Knock. Users are the most common recipients of notifica…
9 properties3 required
PushChannelDataTokensOnly
object
Push channel data.
1 property1 required
DiscordChannelData
object
Discord channel data.
1 property1 required
SlackTokenConnection
object
A Slack connection token.
3 properties
PreferenceSetChannels
object
Channel preferences.
SlackIncomingWebhookConnection
object
A Slack connection incoming webhook.
1 property1 required
ListAudienceMembersResponse
object
A paginated list of audience members.
2 properties2 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.
