Developer tools
Agent Toolkit
Tools reference
Tools reference
Learn more about the tools available in the Knock Agent Toolkit.
The Knock Agent Toolkit exposes a suite of tools that your AI Agents can invoke to power cross-channel user messaging, without any integration logic. You can find the full list of available tools below.
channels
)
Channels (#listChannels
: List all channels in your Knock account
commits
)
Commits (#listCommits
: List all commits in a single environmentcommitAllChanges
: Commit all changes in an enviroinmentpromoteAllCommits
: Promote all commits from one environment to another
documentation
)
Documentation (#searchDocumentation
: Perform a search of the Knock documentation
emailLayouts
)
Email Layouts (#listEmailLayouts
: List all email layouts in an environmentcreateOrUpdateEmailLayout
: Create or update an email layout in an environment
environments
)
Environments (#listEnvironments
: List all environments in your Knock account
messageTypes
)
Message types (#listMessageTypes
: List all message types in an environmentcreateOrUpdateMessageType
: Create or update a message type in an environment
messages
)
Messages (#getMessageContent
: Get the content of a sent message
objects
)
Objects (#listObjects
: List all objects in a collection in an environmentcreateOrUpdateObject
: Create or update an object in a collectiongetObject
: Get an object in a collection by its idsubscribeUsersToObject
: Subscribe one or more users to an object in a collectionunsubscribeUsersFromObject
: Unsubscribe one or more users from an object in a collection
partials
)
Partials (#listPartials
: List all partials in an environmentgetPartial
: Get a partial by its keycreateOrUpdatePartial
: Create or update a partial in an environment
tenants
)
Tenants (#listTenants
: List all tenants in an environmentcreateOrUpdateTenant
: Create or update a tenant in an environmentgetTenant
: Get a tenant by its key
users
)
Users (#listUsers
: List all users in an environmentcreateOrUpdateUser
: Create or update a user in an environmentgetUser
: Get a user by their idgetUserPreferences
: Get the preferences for a usersetUserPreferences
: Set the preferences for a usergetUserMessages
: Get the messages for a user
workflows
)
Workflows (#listWorkflows
: List all workflows in an environmentgetWorkflow
: Get a workflow by its keytriggerWorkflow
: Trigger a workflow by its keycreateWorkflow
: Create a new workflowcreateOneOffWorkflowSchedule
: Create a one-off schedule for a user to trigger a workflow
workflows
)
Workflow steps (#createOrUpdateEmailStepInWorkflow
: Create or update an email step in a workflowcreateOrUpdateDelayStepInWorkflow
: Create or update a delay step in a workflowcreateOrUpdateBatchStepInWorkflow
: Create or update a batch step in a workflowcreateOrUpdateInAppFeedStepInWorkflow
: Create or update an in-app feed step in a workflowcreateOrUpdatePushStepInWorkflow
: Create or update a push notification step in a workflowcreateOrUpdateSmsStepInWorkflow
: Create or update an SMS step in a workflowcreateOrUpdateChatStepInWorkflow
: Create or update a chat step in a workflow