Tools reference

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.

• listChannels: List all channels in your Knock account

• listCommits: List all commits in a single environment
• commitAllChanges: Commit all changes in an environment
• promoteAllCommits: Promote all commits from one environment to another

• searchDocumentation: Perform a search of the Knock documentation

• listEmailLayouts: List all email layouts in an environment
• getEmailLayout: Get an email layout by its key
• createOrUpdateEmailLayout: Create or update an email layout in an environment

• listEnvironments: List all environments in your Knock account

• listGuides: List all guides available for the given environment
• getGuide: Get a guide by its key
• createOrUpdateGuide: Create or update a guide

• listMessageTypes: List all message types in an environment
• createOrUpdateMessageType: Create or update a message type in an environment

• getMessage: Get a message by its ID
• getMessageContent: Get the content of a sent message
• getMessageDeliveryLogs: Get the delivery logs for a message
• getMessageEvents: Get the event timeline for a message

• listObjects: List all objects in a collection in an environment
• getObject: Get an object in a collection by its id
• createOrUpdateObject: Create or update an object in a collection
• subscribeUsersToObject: Subscribe one or more users to an object in a collection
• unsubscribeUsersFromObject: Unsubscribe one or more users from an object in a collection

• listPartials: List all partials in an environment
• getPartial: Get a partial by its key
• createOrUpdatePartial: Create or update a partial in an environment

• listTenants: List all tenants in an environment
• getTenant: Get a tenant by its key
• createOrUpdateTenant: Create or update a tenant in an environment

• getUser: Get a user by their id
• createOrUpdateUser: Create or update a user in an environment
• getUserPreferences: Get the preferences for a user
• setUserPreferences: Set the preferences for a user
• getUserMessages: Get the messages for a user

• listWorkflows: List all workflows in an environment
• getWorkflow: Get a workflow by its key
• triggerWorkflow: Trigger a workflow by its key
• createWorkflow: Create a new workflow
• createOneOffWorkflowSchedule: Create a one-off schedule for a user to trigger a workflow

• createOrUpdateEmailStepInWorkflow: Create or update an email step in a workflow
• createOrUpdateDelayStepInWorkflow: Create or update a delay step in a workflow
• createOrUpdateBatchStepInWorkflow: Create or update a batch step in a workflow
• createOrUpdateInAppFeedStepInWorkflow: Create or update an in-app feed step in a workflow
• createOrUpdatePushStepInWorkflow: Create or update a push notification step in a workflow
• createOrUpdateSmsStepInWorkflow: Create or update an SMS step in a workflow
• createOrUpdateChatStepInWorkflow: Create or update a chat step in a workflow