Docs

Contact support Log in Get started

InAppFeedTemplate

RequestTemplate

WebhookTemplate

List email layouts

Get email layout

Upsert email layout

Validate email layout

Commit all changes

Promote all changes

Promote one commit

Upsert a partial

Validate a partial

List translations

Get translation

Upsert translation

Validate translation

List message types

Get message type

Upsert message type

Validate message type

MessageTypeVariant

MessageTypeTextField

Exchange for API key

List channel groups

ChannelGroupRule

ChatChannelSettings

EmailChannelSettings

PushChannelSettings

SmsChannelSettings

InAppFeedChannelSettings

List environments

Get an environment

Archive a guide

Validate a guide

Activate a guide

GuideActivationUrlPattern

Delete a branch

Create a branch

Send a broadcast

Validate a broadcast

List broadcasts

Get a broadcast

Upsert a broadcast

Cancel a scheduled broadcast

BroadcastRequest

Get started Log in Contact support

Developer tools

API keys Management API reference

Complete reference documentation for the API keys resource.

API keys

#

API keys are used to authenticate requests to the Knock API.

Endpoints

POST/v1/api_keys/exchange

Exchange for API key

#

Given an authenticated service token and an environment, will exchange the service token for a secret API key that can be used to make requests to the public API.

Endpoint

POST/v1/api_keys/exchange

Query parameters

environment

string

The environment slug.

Returns

ExchangeForApiKeyResponse

Returns an API key that can be used to make requests to the public API.

api_key

string

The secret API key exchanged from the service token.

New chat