productivity
Featurebase Lua API for KosmoKrator Agents
Agent-facing Lua documentation and function reference for the Featurebase KosmoKrator integration.Lua Namespace
Agents call this integration through app.integrations.featurebase.*.
Use lua_read_doc("integrations.featurebase") inside KosmoKrator to discover the same reference at runtime.
Call Lua from the Headless CLI
Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic
Featurebase workflow without starting an interactive agent session.
kosmo integrations:lua --eval 'dump(app.integrations.featurebase.list_boards({}))' --jsonkosmo integrations:lua --eval 'print(docs.read("featurebase"))' --json
kosmo integrations:lua --eval 'print(docs.read("featurebase.list_boards"))' --jsonWorkflow file
Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.
local featurebase = app.integrations.featurebase
local result = featurebase.list_boards({})
dump(result)kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --jsonintegrations:lua exposes app.integrations.featurebase, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.featurebase.default.* or app.integrations.featurebase.work.* when you configured named credential accounts.
MCP-only Lua
If the script only needs configured MCP servers and does not need Featurebase, use the narrower mcp:lua command.
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --jsonAgent-Facing Lua Docs
This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.
Featurebase
Use the featurebase namespace to work with the Featurebase 2026-01-01.nova REST API.
Authentication uses Authorization: Bearer <api-key>. The integration also sends the Featurebase-Version header, defaulting to 2026-01-01.nova.
Coverage
This package exposes one first-class tool for each operation listed in the official Featurebase API reference:
- Boards, posts, voters, post statuses, comments, and custom fields
- Changelogs and changelog subscribers
- Admins, admin roles, teams, and brands
- Contacts, contact email preferences, companies, and company-contact membership
- Surveys and survey responses
- Help center help centers, collections, articles, and redirect rules
- Conversations, conversation tags, participants, replies, and redaction
- Tickets, ticket replies, ticket custom fields, categories, and statuses
- Webhooks and webhook secret rotation
Argument shape
Path parameters are exposed as snake_case top-level arguments. For example, the API path {userId} becomes user_id, and {contactId} becomes contact_id.
Query parameters and JSON request bodies go in payload using the API’s documented field names.
featurebase_create_post({
payload = {
boardId = "board_123",
title = "Add invoice exports",
content = "<p>Customers need CSV and PDF exports.</p>",
tags = {"billing", "export"}
}
})featurebase_get_contact_by_user_id({
user_id = "external-user-123"
})featurebase_reply_to_conversation({
id = "conv_123",
payload = {
body = "Thanks for the extra context.",
author = {
type = "admin",
id = "admin_123"
}
}
})The raw featurebase_api_get, featurebase_api_post, featurebase_api_patch, and featurebase_api_delete tools only accept relative paths such as /v2/boards; full URLs are rejected.
Raw agent markdown
# Featurebase
Use the `featurebase` namespace to work with the Featurebase `2026-01-01.nova` REST API.
Authentication uses `Authorization: Bearer <api-key>`. The integration also sends the `Featurebase-Version` header, defaulting to `2026-01-01.nova`.
## Coverage
This package exposes one first-class tool for each operation listed in the official Featurebase API reference:
- Boards, posts, voters, post statuses, comments, and custom fields
- Changelogs and changelog subscribers
- Admins, admin roles, teams, and brands
- Contacts, contact email preferences, companies, and company-contact membership
- Surveys and survey responses
- Help center help centers, collections, articles, and redirect rules
- Conversations, conversation tags, participants, replies, and redaction
- Tickets, ticket replies, ticket custom fields, categories, and statuses
- Webhooks and webhook secret rotation
## Argument shape
Path parameters are exposed as snake_case top-level arguments. For example, the API path `{userId}` becomes `user_id`, and `{contactId}` becomes `contact_id`.
Query parameters and JSON request bodies go in `payload` using the API's documented field names.
```lua
featurebase_create_post({
payload = {
boardId = "board_123",
title = "Add invoice exports",
content = "<p>Customers need CSV and PDF exports.</p>",
tags = {"billing", "export"}
}
})
```
```lua
featurebase_get_contact_by_user_id({
user_id = "external-user-123"
})
```
```lua
featurebase_reply_to_conversation({
id = "conv_123",
payload = {
body = "Thanks for the extra context.",
author = {
type = "admin",
id = "admin_123"
}
}
})
```
The raw `featurebase_api_get`, `featurebase_api_post`, `featurebase_api_patch`, and `featurebase_api_delete` tools only accept relative paths such as `/v2/boards`; full URLs are rejected.local result = app.integrations.featurebase.list_boards({})
print(result)Functions
list_boards Read
Returns all boards (post categories) for the authenticated organization.
- Lua path
app.integrations.featurebase.list_boards- Full name
featurebase.featurebase_list_boards
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_board Read
Retrieves a single board by its unique identifier.
- Lua path
app.integrations.featurebase.get_board- Full name
featurebase.featurebase_get_board
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_posts Read
Returns all posts (feedback submissions) for the authenticated organization.
- Lua path
app.integrations.featurebase.list_posts- Full name
featurebase.featurebase_list_posts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_post Write
Creates a new post (feedback submission) in the specified board.
- Lua path
app.integrations.featurebase.create_post- Full name
featurebase.featurebase_create_post
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_post Read
Retrieves a single post by its unique identifier.
- Lua path
app.integrations.featurebase.get_post- Full name
featurebase.featurebase_get_post
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_post Write
Updates an existing post. Only provided fields will be modified.
- Lua path
app.integrations.featurebase.update_post- Full name
featurebase.featurebase_update_post
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_post Write
Permanently deletes a post. This action cannot be undone.
- Lua path
app.integrations.featurebase.delete_post- Full name
featurebase.featurebase_delete_post
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_voters Read
Returns all voters (upvoters) for a specific post.
- Lua path
app.integrations.featurebase.list_voters- Full name
featurebase.featurebase_list_voters
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
add_voter Write
Adds a voter (upvote) to a post.
- Lua path
app.integrations.featurebase.add_voter- Full name
featurebase.featurebase_add_voter
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
remove_voter Write
Removes a voter (upvote) from a post.
- Lua path
app.integrations.featurebase.remove_voter- Full name
featurebase.featurebase_remove_voter
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_post_statuses Read
Returns all post statuses for the authenticated organization.
- Lua path
app.integrations.featurebase.list_post_statuses- Full name
featurebase.featurebase_list_post_statuses
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_post_status Read
Retrieves a single post status by its unique identifier.
- Lua path
app.integrations.featurebase.get_post_status- Full name
featurebase.featurebase_get_post_status
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_comments Read
Returns comments for your organization.
- Lua path
app.integrations.featurebase.list_comments- Full name
featurebase.featurebase_list_comments
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_comment Write
Creates a new comment or reply to an existing comment.
- Lua path
app.integrations.featurebase.create_comment- Full name
featurebase.featurebase_create_comment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_comment Read
Retrieves a single comment by its unique identifier.
- Lua path
app.integrations.featurebase.get_comment- Full name
featurebase.featurebase_get_comment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_comment Write
Updates an existing comment by its unique identifier.
- Lua path
app.integrations.featurebase.update_comment- Full name
featurebase.featurebase_update_comment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_comment Write
Deletes a comment by its unique identifier.
- Lua path
app.integrations.featurebase.delete_comment- Full name
featurebase.featurebase_delete_comment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_comment_clover Write
Deletes a comment using the legacy Clover API format.
- Lua path
app.integrations.featurebase.delete_comment_clover- Full name
featurebase.featurebase_delete_comment_clover
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_custom_fields Read
Returns all custom fields configured in your organization.
- Lua path
app.integrations.featurebase.list_custom_fields- Full name
featurebase.featurebase_list_custom_fields
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_custom_field Read
Retrieves a single custom field by its unique identifier.
- Lua path
app.integrations.featurebase.get_custom_field- Full name
featurebase.featurebase_get_custom_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_changelogs Read
Returns all changelogs for the authenticated organization.
- Lua path
app.integrations.featurebase.list_changelogs- Full name
featurebase.featurebase_list_changelogs
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_changelog Write
Creates a new changelog for the authenticated organization.
- Lua path
app.integrations.featurebase.create_changelog- Full name
featurebase.featurebase_create_changelog
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_changelog Read
Retrieves a single changelog by its unique identifier or slug.
- Lua path
app.integrations.featurebase.get_changelog- Full name
featurebase.featurebase_get_changelog
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_changelog Write
Updates an existing changelog by its unique identifier.
- Lua path
app.integrations.featurebase.update_changelog- Full name
featurebase.featurebase_update_changelog
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_changelog Write
Deletes a changelog by its unique identifier.
- Lua path
app.integrations.featurebase.delete_changelog- Full name
featurebase.featurebase_delete_changelog
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
publish_changelog Write
Publishes a changelog and optionally sends an email notification to subscribers.
- Lua path
app.integrations.featurebase.publish_changelog- Full name
featurebase.featurebase_publish_changelog
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
unpublish_changelog Write
Unpublishes a changelog, removing it from public view.
- Lua path
app.integrations.featurebase.unpublish_changelog- Full name
featurebase.featurebase_unpublish_changelog
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
add_changelog_subscribers Write
Adds email addresses as changelog subscribers in bulk.
- Lua path
app.integrations.featurebase.add_changelog_subscribers- Full name
featurebase.featurebase_add_changelog_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
remove_changelog_subscribers Write
Removes email addresses from changelog subscribers in bulk.
- Lua path
app.integrations.featurebase.remove_changelog_subscribers- Full name
featurebase.featurebase_remove_changelog_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_admins Read
Returns all admins for your organization.
- Lua path
app.integrations.featurebase.list_admins- Full name
featurebase.featurebase_list_admins
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_admin Read
Retrieves a single admin by their unique identifier.
- Lua path
app.integrations.featurebase.get_admin- Full name
featurebase.featurebase_get_admin
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_admin_roles Read
Returns all available admin roles and their permissions.
- Lua path
app.integrations.featurebase.list_admin_roles- Full name
featurebase.featurebase_list_admin_roles
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_teams Read
Returns all teams in your organization.
- Lua path
app.integrations.featurebase.list_teams- Full name
featurebase.featurebase_list_teams
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_team_by_id Read
Retrieves a single team by its Featurebase ID.
- Lua path
app.integrations.featurebase.get_team_by_id- Full name
featurebase.featurebase_get_team_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_brands Read
Returns all brands in your organization with cursor-based pagination.
- Lua path
app.integrations.featurebase.list_brands- Full name
featurebase.featurebase_list_brands
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_brand_by_id Read
Retrieves a single brand by its Featurebase ID.
- Lua path
app.integrations.featurebase.get_brand_by_id- Full name
featurebase.featurebase_get_brand_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_contacts Read
Returns a list of contacts (customers and leads) in your organization using cursor-based pagination.
- Lua path
app.integrations.featurebase.list_contacts- Full name
featurebase.featurebase_list_contacts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
upsert_contact Write
Creates a new contact or updates an existing one.
- Lua path
app.integrations.featurebase.upsert_contact- Full name
featurebase.featurebase_upsert_contact
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_contact_by_id Read
Retrieves a single contact by their Featurebase ID.
- Lua path
app.integrations.featurebase.get_contact_by_id- Full name
featurebase.featurebase_get_contact_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_contact_by_id Write
Permanently deletes a contact by their Featurebase ID.
- Lua path
app.integrations.featurebase.delete_contact_by_id- Full name
featurebase.featurebase_delete_contact_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_contact_by_user_id Read
Retrieves a single contact by their external user ID (from your system via SSO).
- Lua path
app.integrations.featurebase.get_contact_by_user_id- Full name
featurebase.featurebase_get_contact_by_user_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_contact_by_user_id Write
Permanently deletes a contact by their external user ID.
- Lua path
app.integrations.featurebase.delete_contact_by_user_id- Full name
featurebase.featurebase_delete_contact_by_user_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_contact_email_preferences_by_id Read
Retrieves the email preference state for a customer contact by their Featurebase ID.
- Lua path
app.integrations.featurebase.get_contact_email_preferences_by_id- Full name
featurebase.featurebase_get_contact_email_preferences_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_contact_email_preferences_by_id Write
Updates one or more email preferences for a customer contact by their Featurebase ID.
- Lua path
app.integrations.featurebase.update_contact_email_preferences_by_id- Full name
featurebase.featurebase_update_contact_email_preferences_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_contact_email_preferences_by_user_id Read
Retrieves the email preference state for a customer contact by their external user ID.
- Lua path
app.integrations.featurebase.get_contact_email_preferences_by_user_id- Full name
featurebase.featurebase_get_contact_email_preferences_by_user_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_contact_email_preferences_by_user_id Write
Updates one or more email preferences for a customer contact by their external user ID.
- Lua path
app.integrations.featurebase.update_contact_email_preferences_by_user_id- Full name
featurebase.featurebase_update_contact_email_preferences_by_user_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
block_contact_by_id Write
Blocks a contact by their Featurebase ID from the messenger/inbox.
- Lua path
app.integrations.featurebase.block_contact_by_id- Full name
featurebase.featurebase_block_contact_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
unblock_contact_by_id Write
Unblocks a contact by their Featurebase ID from the messenger/inbox.
- Lua path
app.integrations.featurebase.unblock_contact_by_id- Full name
featurebase.featurebase_unblock_contact_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_companies Read
Returns all companies in your organization with cursor-based pagination.
- Lua path
app.integrations.featurebase.list_companies- Full name
featurebase.featurebase_list_companies
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
upsert_company Write
Creates a new company or updates an existing one.
- Lua path
app.integrations.featurebase.upsert_company- Full name
featurebase.featurebase_upsert_company
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_company_by_id Read
Retrieves a single company by its Featurebase ID.
- Lua path
app.integrations.featurebase.get_company_by_id- Full name
featurebase.featurebase_get_company_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_company_by_id Write
Deletes a company by its Featurebase ID.
- Lua path
app.integrations.featurebase.delete_company_by_id- Full name
featurebase.featurebase_delete_company_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_company_by_company_id Write
Permanently deletes a company by its external company ID (the companyId from your system).
- Lua path
app.integrations.featurebase.delete_company_by_company_id- Full name
featurebase.featurebase_delete_company_by_company_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_company_contacts Read
Returns all contacts (customers) attached to a specific company.
- Lua path
app.integrations.featurebase.list_company_contacts- Full name
featurebase.featurebase_list_company_contacts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
attach_contact_company Write
Attaches a contact (customer) to a company.
- Lua path
app.integrations.featurebase.attach_contact_company- Full name
featurebase.featurebase_attach_contact_to_company
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
remove_contact_from_company Write
Removes a contact (customer) from a company.
- Lua path
app.integrations.featurebase.remove_contact_from_company- Full name
featurebase.featurebase_remove_contact_from_company
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_surveys Read
Returns all surveys configured in your Featurebase organization.
- Lua path
app.integrations.featurebase.list_surveys- Full name
featurebase.featurebase_list_surveys
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_survey Read
Retrieves a single survey by its unique identifier.
- Lua path
app.integrations.featurebase.get_survey- Full name
featurebase.featurebase_get_survey
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_survey_responses Read
Retrieves all user responses for a specific survey.
- Lua path
app.integrations.featurebase.get_survey_responses- Full name
featurebase.featurebase_get_survey_responses
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_help_centers Read
Returns all help centers configured in your Featurebase organization.
- Lua path
app.integrations.featurebase.list_help_centers- Full name
featurebase.featurebase_list_help_centers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_help_center Read
Retrieves a single help center by its unique identifier.
- Lua path
app.integrations.featurebase.get_help_center- Full name
featurebase.featurebase_get_help_center
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_collections Read
Returns a paginated list of collections within your organization's help center.
- Lua path
app.integrations.featurebase.list_collections- Full name
featurebase.featurebase_list_collections
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_collection Write
Creates a new collection in your organization's help center.
- Lua path
app.integrations.featurebase.create_collection- Full name
featurebase.featurebase_create_collection
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_collection Read
Retrieves a specific collection by its unique identifier.
- Lua path
app.integrations.featurebase.get_collection- Full name
featurebase.featurebase_get_collection
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_collection Write
Updates an existing collection. Only include the fields you wish to update.
- Lua path
app.integrations.featurebase.update_collection- Full name
featurebase.featurebase_update_collection
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_collection Write
Deletes an existing collection.
- Lua path
app.integrations.featurebase.delete_collection- Full name
featurebase.featurebase_delete_collection
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_articles Read
Returns a paginated list of articles within your organization's help center.
- Lua path
app.integrations.featurebase.list_articles- Full name
featurebase.featurebase_list_articles
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_article Write
Creates a new article in your organization's help center.
- Lua path
app.integrations.featurebase.create_article- Full name
featurebase.featurebase_create_article
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_article Read
Retrieves a specific article by its unique identifier.
- Lua path
app.integrations.featurebase.get_article- Full name
featurebase.featurebase_get_article
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_article Write
Updates an existing article. Only include the fields you wish to update.
- Lua path
app.integrations.featurebase.update_article- Full name
featurebase.featurebase_update_article
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_article Write
Deletes an existing article.
- Lua path
app.integrations.featurebase.delete_article- Full name
featurebase.featurebase_delete_article
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_redirect_rules Read
Returns a paginated list of redirect rules within your organization.
- Lua path
app.integrations.featurebase.list_redirect_rules- Full name
featurebase.featurebase_list_redirect_rules
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_redirect_rule Write
Creates a new redirect rule in your organization.
- Lua path
app.integrations.featurebase.create_redirect_rule- Full name
featurebase.featurebase_create_redirect_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_redirect_rule_by_url Read
Retrieves a specific redirect rule by its source URL.
- Lua path
app.integrations.featurebase.get_redirect_rule_by_url- Full name
featurebase.featurebase_get_redirect_rule_by_url
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_redirect_rule Read
Retrieves a specific redirect rule by its unique identifier.
- Lua path
app.integrations.featurebase.get_redirect_rule- Full name
featurebase.featurebase_get_redirect_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_redirect_rule Write
Updates an existing redirect rule. Only include the fields you wish to update.
- Lua path
app.integrations.featurebase.update_redirect_rule- Full name
featurebase.featurebase_update_redirect_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_redirect_rule Write
Deletes an existing redirect rule. The associated Redis cache entry is also invalidated.
- Lua path
app.integrations.featurebase.delete_redirect_rule- Full name
featurebase.featurebase_delete_redirect_rule
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_conversations Read
Returns a list of conversations in your organization using cursor-based pagination.
- Lua path
app.integrations.featurebase.list_conversations- Full name
featurebase.featurebase_list_conversations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_conversation Write
Creates a new conversation. Supports both contact-initiated (customer/lead) and admin-initiated (outreach) conversations.
- Lua path
app.integrations.featurebase.create_conversation- Full name
featurebase.featurebase_create_conversation
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_conversation_by_id Read
Retrieves a single conversation by its ID, including conversation parts (messages).
- Lua path
app.integrations.featurebase.get_conversation_by_id- Full name
featurebase.featurebase_get_conversation_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_conversation Write
Permanently deletes a conversation by its short ID.
- Lua path
app.integrations.featurebase.delete_conversation- Full name
featurebase.featurebase_delete_conversation
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_conversation Write
Updates a conversation's properties. Supports partial updates - only provided fields will be updated.
- Lua path
app.integrations.featurebase.update_conversation- Full name
featurebase.featurebase_update_conversation
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
attach_conversation_tag Write
Attaches a workspace tag to a conversation.
- Lua path
app.integrations.featurebase.attach_conversation_tag- Full name
featurebase.featurebase_attach_conversation_tag
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
detach_conversation_tag Write
Removes a workspace tag from a conversation.
- Lua path
app.integrations.featurebase.detach_conversation_tag- Full name
featurebase.featurebase_detach_conversation_tag
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
reply_conversation Write
Adds a reply to an existing conversation. Supports both contact (customer/lead) and admin replies.
- Lua path
app.integrations.featurebase.reply_conversation- Full name
featurebase.featurebase_reply_to_conversation
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
add_participant_conversation Write
Adds a contact (customer or lead) as a participant to an existing conversation.
- Lua path
app.integrations.featurebase.add_participant_conversation- Full name
featurebase.featurebase_add_participant_to_conversation
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
remove_participant_from_conversation Write
Removes a contact (customer or lead) from an existing conversation.
- Lua path
app.integrations.featurebase.remove_participant_from_conversation- Full name
featurebase.featurebase_remove_participant_from_conversation
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
redact_conversation_part Write
Redacts a conversation part (message) from a conversation. Redaction permanently removes the message content while preserving the conversation structure.
- Lua path
app.integrations.featurebase.redact_conversation_part- Full name
featurebase.featurebase_redact_conversation_part
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_tags Read
Returns the live conversation tags available in the workspace tag catalog. These are the canonical tags that power conversation payloads, filters, and tag mutation endpoints.
- Lua path
app.integrations.featurebase.list_tags- Full name
featurebase.featurebase_list_tags
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
upsert_tag Write
Creates a new workspace conversation tag when only name is provided. If id is also provided, the existing tag is renamed instead.
- Lua path
app.integrations.featurebase.upsert_tag- Full name
featurebase.featurebase_upsert_tag
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_tag_by_id Read
Returns a single conversation tag by its Featurebase tag ID. Archived tags can still be retrieved directly by ID, while permanently deleted tags return 404.
- Lua path
app.integrations.featurebase.get_tag_by_id- Full name
featurebase.featurebase_get_tag_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_tag Write
Deletes a conversation tag from the workspace catalog and removes it from aggregate conversation tag state. Archived and historical part applications remain part of the audit trail where applicable.
- Lua path
app.integrations.featurebase.delete_tag- Full name
featurebase.featurebase_delete_tag
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_tickets Read
Returns a list of tickets in your organization using cursor-based pagination.
- Lua path
app.integrations.featurebase.list_tickets- Full name
featurebase.featurebase_list_tickets
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_ticket Write
Creates a new ticket.
- Lua path
app.integrations.featurebase.create_ticket- Full name
featurebase.featurebase_create_ticket
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_ticket Read
Retrieves a single ticket by its ticket number.
- Lua path
app.integrations.featurebase.get_ticket- Full name
featurebase.featurebase_get_ticket
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_ticket Write
Updates a ticket's properties. Only provided fields will be updated.
- Lua path
app.integrations.featurebase.update_ticket- Full name
featurebase.featurebase_update_ticket
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_ticket Write
Permanently deletes a ticket by its ticket number.
- Lua path
app.integrations.featurebase.delete_ticket- Full name
featurebase.featurebase_delete_ticket
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
reply_ticket Write
Adds a reply to a ticket's linked conversation. Supports both contact and admin replies.
- Lua path
app.integrations.featurebase.reply_ticket- Full name
featurebase.featurebase_reply_to_ticket
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_ticket_custom_fields Read
Returns all custom fields configured in your organization that can be used on tickets.
- Lua path
app.integrations.featurebase.list_ticket_custom_fields- Full name
featurebase.featurebase_list_ticket_custom_fields
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_ticket_custom_field Read
Retrieves a single custom field by its unique identifier.
- Lua path
app.integrations.featurebase.get_ticket_custom_field- Full name
featurebase.featurebase_get_ticket_custom_field
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_ticket_categories Read
Returns all ticket categories for the authenticated organization.
- Lua path
app.integrations.featurebase.list_ticket_categories- Full name
featurebase.featurebase_list_ticket_categories
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_ticket_category Read
Retrieves a single ticket category by its unique identifier.
- Lua path
app.integrations.featurebase.get_ticket_category- Full name
featurebase.featurebase_get_ticket_category
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_ticket_statuses Read
Returns all ticket statuses for the authenticated organization.
- Lua path
app.integrations.featurebase.list_ticket_statuses- Full name
featurebase.featurebase_list_ticket_statuses
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_ticket_status Read
Retrieves a single ticket status by its unique identifier.
- Lua path
app.integrations.featurebase.get_ticket_status- Full name
featurebase.featurebase_get_ticket_status
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_webhooks Read
Returns a list of webhooks in your organization using cursor-based pagination.
- Lua path
app.integrations.featurebase.list_webhooks- Full name
featurebase.featurebase_list_webhooks
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_webhook Write
Creates a new webhook to receive event notifications.
- Lua path
app.integrations.featurebase.create_webhook- Full name
featurebase.featurebase_create_webhook
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_webhook_by_id Read
Retrieves a single webhook by its unique identifier.
- Lua path
app.integrations.featurebase.get_webhook_by_id- Full name
featurebase.featurebase_get_webhook_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_webhook Write
Updates a webhook's properties. Supports partial updates - only provided fields will be updated.
- Lua path
app.integrations.featurebase.update_webhook- Full name
featurebase.featurebase_update_webhook
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_webhook Write
Permanently deletes a webhook.
- Lua path
app.integrations.featurebase.delete_webhook- Full name
featurebase.featurebase_delete_webhook
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
refresh_webhook_secret Write
Generates a new signing secret for a webhook. The previous secret is immediately invalidated.
- Lua path
app.integrations.featurebase.refresh_webhook_secret- Full name
featurebase.featurebase_refresh_webhook_secret
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||