Method & Identifier Index#
What this covers: a flat A–Z lookup from any name you might grep for — this.* methods, communicate.* methods, kizen.json manifest fields, artifact config.json fields, REST endpoints, Python kizen.api methods, setup-assistant field types, and platform identifiers — to the doc section that owns it. Link labels are file numbers (see the legend). Where a name has per-surface headings in several docs, every location is listed.
See also: README.md for reading order · glossary for definitions · 17-gotchas.md for the consolidated trap list · examples/ for real call sites in complete plugin source.
By task#
| Task | Go to |
|---|---|
| Understand the platform / execution model | 01-overview.md |
| Set up a repo, run the dev loop | 02-getting-started.md |
Write or validate kizen.json |
03-manifest-reference.md |
Look up a this.* signature |
04-worker-runtime-api.md |
| Call the Kizen REST API | 05-platform-api.md (endpoint shapes) + 04 §4 HTTP (JS helpers) |
| Call an external API / hold a credential / OAuth | 06-auth-secrets-services.md |
| Build an Agentic Workflow step (Python) | 07-automation-steps.md |
| Add a record action or create override | 08-actions.md |
| Render UI | blocks: 09-blocks.md · modals/forms: 10-views-modals-forms.md · outputUI/iframes/frames: 11-output-ui-iframes-frames.md |
| Route scripts, calendar sources, adornments, settings items | 12-routes-calendars-adornments-settings.md |
| Ship an install-time config wizard | 13-setup-assistants.md |
| Navigate or pass data between surfaces | 14-navigation-and-communication.md |
Decide throw vs onError vs showToast |
15-errors-and-observability.md |
| Release a version | 16-release-and-publish.md |
| Debug something weird | 17-gotchas.md |
| Copy a working end-to-end build | 18-recipes.md |
| Read a whole real plugin / find live call sites | examples/ — kitchen_sink.md (every surface) · google_calendar.md (production OAuth + calendar source) |
Link legend#
01 overview · 02 getting started · 03 manifest · 04 worker runtime · 05 platform API · 06 auth & services · 07 workflow steps · 08 actions · 09 blocks · 10 views & modals · 11 output UI & frames · 12 routes/calendars/adornments/settings · 13 setup assistants · 14 navigation & communication · 15 errors · 16 release · glossary glossary.md
A–Z index#
| Identifier | Kind | Where |
|---|---|---|
action_description |
step config field | 07 |
this.actionEntity() |
this.* method |
04 |
this.actionObjectId / this.actionEntityId |
this.* data member |
04 |
actionOverrideCreate (action_override_create) |
install-time association setting | 08 · glossary |
actions/<name>/ |
artifact directory | 03 · 08 |
actions step (assistant) |
assistant section | 13 |
action_type |
step config field | 07 |
POST /api/activities |
REST endpoint | 05 |
GET /api/activities |
REST endpoint | 05 |
POST /api/activities/{activity_identifier}/log-activity |
REST endpoint | 05 |
POST /api/activities/{activity_identifier}/responses |
REST endpoint | 05 |
GET /api/activities/logged/{id} |
REST endpoint | 05 |
POST /api/activities/scheduled-activity |
REST endpoint | 05 |
GET /api/activities/scheduled-activity |
REST endpoint | 05 |
GET|PUT|PATCH|DELETE /api/activities/scheduled-activity/{id} |
REST endpoint | 05 |
PATCH /api/activities/scheduled-activity/{id}/notes |
REST endpoint | 05 |
POST /api/activities/scheduled-activity/search |
REST endpoint | 05 |
add_values |
record field-write shape | 08 · 05 |
additional_service_urls |
service field | 06 |
| Agentic Workflow | vocabulary | glossary · 07 |
allowed_values |
step parameter field | 07 |
api_name (manifest / per artifact) |
manifest & artifact config field | 03 · 03 · 07 · 08 · 09 · 12 · 12 · 12 · glossary |
this.applicationPath |
this.* data member |
04 |
this.args |
this.* data member |
04 |
assistant.json |
assistant config file | 13 |
GET /api/auth/bootstrap |
REST endpoint | 05 |
auth_credentials |
service field | 06 · 03 |
auth_level |
service field | 06 |
this.authorize(serviceName, config?) |
this.* method |
04 · 06 |
auth_type: "basic_auth_token_exchange" / "private_key_jwt" |
service field | 06 |
auth_type: "basic_auth_token_provided" |
service field | 03 · 06 |
auth_type: "no_auth" |
service field | 03 · 06 |
auth_type: "oauth" |
service field | 03 · 06 · 06 |
auth_type: "password_token_exchange" |
service field | 06 |
GET|POST /api/automations/{automation_identifier}/webhook/{webhook_name} |
REST endpoint | 05 |
automationSteps/<name>/ |
artifact directory | 03 · 07 |
base_config |
manifest field | 03 · glossary |
base_config.disabled_keys |
manifest field | 13 |
base_config.secrets |
manifest field | 06 · 16 |
base_service_url |
service field | 06 |
blocking (route script, install-time) |
install-time association setting | 12 |
block_loading_for_setup |
manifest field | 03 |
blocks/<name>/ |
artifact directory | 03 · 09 |
boolean (assistant field type) |
assistant field type | 13 |
| Business config | concept | 05 · glossary |
GET /api/business/mine |
REST endpoint | 05 |
PATCH /api/business/mine |
REST endpoint | 05 |
| Business plugin app | concept | glossary · 05 |
calendarSources/<name>/ |
artifact directory | 03 · 12 |
calendars_script (calendars.js) |
calendar-source config field | 12 |
callback.js (page callback script) |
file convention | 10 |
this.clearToasts() |
this.* method |
04 |
POST /api/client |
REST endpoint | 05 |
GET /api/client/custom-object |
REST endpoint | 05 |
this.closeModal(values?, canceled?) |
this.* method |
04 · 10 |
color (data adornment) |
adornment config field | 12 |
this.config |
this.* data member |
04 |
this.completeSetup(payload, options?) |
this.* method |
04 · 13 |
config_template |
manifest field | 03 · glossary |
conflict_resolution (outputs only) |
step parameter field | 07 |
connection_secret_tag |
input convention | 06 |
this.console |
this.* data member |
04 |
GET /api/constants/currencies |
REST endpoint | 05 |
container (assistant field type) |
assistant field type | 13 |
this.copyToClipboard(text) |
this.* method |
04 |
this.createDateObject(dateString) |
this.* method |
04 |
create_field_options (outputs only) |
step parameter field | 07 |
this.currentBusiness |
this.* data member |
04 |
this.currentEntity() |
this.* method |
04 |
this.currentObject() |
this.* method |
04 |
this.currentUser |
this.* data member |
04 |
customIcon / customIconFile |
adornment config field | 12 |
custom_object (assistant field type) |
assistant field type | 13 |
POST /api/custom-objects |
REST endpoint | 05 |
GET /api/custom-objects |
REST endpoint | 05 |
GET /api/custom-objects/{identifier} |
REST endpoint | 05 |
DELETE /api/custom-objects/{object_id} |
REST endpoint | 05 |
GET /api/custom-objects/{object_id}/categories |
REST endpoint | 05 |
GET /api/custom-objects/{object_id}/detail |
REST endpoint | 05 |
GET /api/custom-objects/{object_id}/fields |
REST endpoint | 05 |
POST /api/custom-objects/{object_id}/fields |
REST endpoint | 05 |
PATCH /api/custom-objects/{object_id}/fields/{field_id} |
REST endpoint | 05 |
DELETE /api/custom-objects/{object_id}/fields/{field_id} |
REST endpoint | 05 |
POST /api/custom-objects/{object_id}/fields/{field_id}/options |
REST endpoint | 05 |
POST /api/custom-objects/{object_id}/fields/search (also settings-search, references) |
REST endpoint | 05 |
GET /api/custom-objects/settings-search |
REST endpoint | 05 |
Dashlet chrome contract (dashletStyleConfig.dropShadow) |
concept | 09 |
dataAdornments/<name>/ |
artifact directory | 03 · 12 |
data-script (event dispatch attribute) |
identifier | 11 · glossary |
data_type |
step parameter field | 07 · 07 |
this.debug |
this.* data member |
04 |
default_position |
frame config field | 11 |
default (step parameter) |
step parameter field | 07 |
kizen.api.delete(path, **kwargs) |
Python kizen.api |
07 · 07 |
this.delete(url, options?) |
this.* method |
04 |
this.deleteWithErrors(url, options?) |
this.* method |
04 |
dependencies (cascading assistant fields) |
assistant config | 13 |
description (assistant field type) |
assistant field type | 13 |
description (manifest) |
manifest field | 03 |
developer_business_id |
manifest field | 03 · 03 · glossary |
this.dynamicPrompt(config) |
this.* method |
04 · 10 · glossary |
GET|POST /api/employee/mine/configs/plugins/{plugin_id} |
REST endpoint | 05 |
Encrypted secret envelope ({"encrypted": true, ...}) |
concept | 06 · 06 |
engine |
manifest field | 03 · glossary |
| Entitlement | concept | 16 · glossary |
entry |
manifest field | 03 · 03 · glossary |
esc() (HTML escaping discipline) |
identifier | 11 |
eventScripts/<handler>.js |
file convention | 03 · glossary |
events_script (events.js) |
calendar-source config field | 12 |
this.expand() / this.collapse() (floating frame) |
this.* method |
04 |
GET /api/external-integrations/bootstrap |
REST endpoint | 05 |
GET /api/external-integrations/business-plugin-apps/{identifier} |
REST endpoint | 05 |
PATCH /api/external-integrations/business-plugin-apps/{identifier} |
REST endpoint | 05 · 13 |
GET /api/external-integrations/business-plugin-apps/{identifier}/services/{service_name}/authorize |
REST endpoint | 06 |
POST /api/external-integrations/business-plugin-apps/{identifier}/services/{service_name}/logout |
REST endpoint | 06 |
GET /api/external-integrations/oauth/callback |
REST endpoint | 06 |
ANY /api/external-integrations/proxy/{plugin_api_name}/{service_name}/{path} |
REST endpoint | 05 · 06 |
external_link |
manifest field | 03 |
field (assistant field type) |
assistant field type | 13 |
FieldOption |
step data type | 07 |
field_type (data adornment) |
adornment config field | 12 |
file / KizenFile |
step data type | 07 |
floatingFrames/<name>/ |
artifact directory | 03 · 11 |
this.formatDateForResponse(date) |
this.* method |
04 |
frameless (modal option) |
modal option | 10 · 10 |
Frame proxy (plugin-assets.kizen.com / plugin-assets.kizen.dev) |
concept | 11 · glossary |
full_domain (proxy query param) |
query param | 06 |
this.getEntity(objectId, entityId) |
this.* method |
04 |
this.getFieldValue(entity, fieldId) |
this.* method |
04 |
this.getObjectDetail(id) |
this.* method |
04 |
kizen.api.get(path, params=None, headers=None, **kwargs) |
Python kizen.api |
07 · 07 |
this.getRelatedEntitiesForField(objectId, entityId, fieldId) |
this.* method |
04 |
this.getServiceUrl(serviceName, path) |
this.* method |
04 · 06 |
this.get(url, options?) |
this.* method |
04 |
this.getUserConfig() |
this.* method |
04 |
this.getWithErrors(url, options?) |
this.* method |
04 |
kizen.api.head(path, **kwargs) |
Python kizen.api |
07 · 07 |
this.hide(config?) (floating frame) |
this.* method |
04 |
this.hideHeader() / this.showHeader() (floating frame) |
this.* method |
04 |
hint |
step parameter field | 07 |
hint_field_name |
step parameter field | 07 |
hint_object_name |
artifact config field | 08 · 12 |
hint_related_object_field_name |
step parameter field | 07 |
icon (data adornment) |
adornment config field | 12 |
image (assistant field type) |
assistant field type | 13 |
import.kzn |
file convention | 03 |
include (identity params on qr / image.link / link) |
assistant field prop | 13 |
include_perform_action |
install-time association setting | 08 · glossary |
input_source |
step parameter field | 07 |
inputs (Python step global) |
Python step global | 07 |
this.installThirdPartyScript(scriptUrl) |
this.* method |
04 |
GET /api/integration-secrets |
REST endpoint | 05 |
POST /api/integration-secrets |
REST endpoint | 05 · 06 |
| Integration secrets | concept | 05 · 06 · glossary |
GET /api/integration-secrets/{id} |
REST endpoint | 05 |
PUT /api/integration-secrets/{id} |
REST endpoint | 05 · 06 |
DELETE /api/integration-secrets/{id} |
REST endpoint | 05 |
is_toolbar_item |
page config field | 11 · 03 · 10 |
kizen.api |
Python kizen.api |
07 · glossary |
__kizen_clean_config |
reserved config key | 04 · 13 · 05 |
kizen.json |
manifest (file) | 03 · 02 · glossary |
KizenRequestError |
error class | 04 · 15 |
__kizen_setup_assistant_values |
reserved config key | 13 · 05 |
__kizen_user_config |
reserved config key | 04 · 13 |
label (step parameter / settings item) |
artifact config field | 07 · 12 |
link (assistant field type) |
assistant field type | 13 |
this.location |
this.* data member |
04 |
manifest/setup-assistant-* (validation rules) |
validation rule | 13 · 03 |
match / ignore (floating frame) |
frame config field | 11 |
message_handler (message.js) |
artifact config field | 11 · 03 |
minimized_style / minimized_config |
frame config field | 11 |
min_w / max_w / min_h / max_h |
block config field | 09 |
| Modal slot (FIFO, no nesting) | concept | 10 |
money_options |
field option | 05 |
| Multi-plugin manifests | manifest concept | 03 |
name (manifest / artifact config) |
manifest & artifact config field | 03 · 07 · 08 · 09 · 12 · 12 |
| Navigation context | concept | 14 · glossary |
npx --yes @kizenapps/cli (the CLI) |
CLI | 02 · glossary |
npx --yes @kizenapps/cli encrypt |
CLI command | 06 |
npx --yes @kizenapps/cli report |
CLI command | 02 · examples |
number (assistant field type) |
assistant field type | 13 |
| OAuth callback (only unauthenticated inbound path) | concept | 06 · 05 |
this.objectId / this.entityId |
this.* data member |
04 |
objectSettingsItems/<name>/ |
artifact directory | 03 · 12 |
this.onError(error?) |
this.* method |
04 · 15 · 08 |
this.openCreateRecordModal(objectId) |
this.* method |
04 · 10 |
this.openCreateRelatedRecordModal(objectId, relatedEntityId) |
this.* method |
04 · 10 |
this.openWindow(url, target?, context?) |
this.* method |
04 · 14 |
kizen.api.options(path, **kwargs) |
Python kizen.api |
07 · 07 |
this.outputIframe(url, allow?, sandbox?, options?) |
this.* method |
04 · 11 |
outputs.log(message) |
Python step global | 07 |
outputs (Python step global) |
Python step global | 07 |
output_target (do not use) |
step parameter field | 07 |
this.outputUI(markup, options?) |
this.* method |
04 · 11 |
this.outputView(viewId, args?) (unsupported) |
this.* method |
04 · 10 · 11 |
pages/<name>/ |
artifact directory | 03 · 10 |
| Pagination | convention | 05 |
this.parseDate(date) |
this.* method |
04 |
this.parsePhone(phone) |
this.* method |
04 |
kizen.api.patch(path, data=None, json=None, headers=None, **kwargs) |
Python kizen.api |
07 · 07 |
this.patch(url, body?, options?) |
this.* method |
04 |
this.patchWithErrors(url, body, options?) |
this.* method |
04 |
POST /api/permission-group |
REST endpoint | 05 |
this.pluginApiName |
this.* data member |
04 |
{plugin_api_name}__{secret_name} (secret naming) |
naming convention | 06 |
plugin_description |
step config field | 07 |
/plugins/{plugin_api_name}/{page_api_name} (page route) |
URL convention | 10 |
this.postFormData(url, data, createNewTab?) |
this.* method |
04 |
kizen.api.post(path, data=None, json=None, headers=None, **kwargs) |
Python kizen.api |
07 · 07 |
this.post(url, body?, options?) |
this.* method |
04 |
this.postWithErrors(url, body, options?) |
this.* method |
04 |
this.preserve |
this.* data member |
04 |
| Preview build | concept | 16 · glossary |
this.prompt(config) (legacy) |
this.* method |
04 · 10 · glossary |
published |
manifest field | 03 |
this.put (does not exist) |
this.* method |
04 |
kizen.api.put(path, data=None, json=None, headers=None, **kwargs) |
Python kizen.api |
07 · 07 |
qr (assistant field type) |
assistant field type | 13 |
| Rate limits & retries | convention | 05 · 07 · 15 |
recommended_height |
block config field | 09 |
POST /api/records/{object}/add |
REST endpoint | 05 |
GET /api/records/{object}/lookup |
REST endpoint | 05 |
GET /api/records/{object}/{record_id} |
REST endpoint | 05 |
PATCH|PUT /api/records/{object}/{record_id} |
REST endpoint | 05 |
DELETE /api/records/{object}/{record_id} |
REST endpoint | 05 |
PATCH /api/records/{object}/{record_id}/move |
REST endpoint | 05 |
PATCH /api/records/{object}/{record_id}/unarchive |
REST endpoint | 05 |
POST /api/records/{object}/search |
REST endpoint | 05 |
POST /api/records/{object}/upsert |
REST endpoint | 05 · 05 |
this.refreshEntity() |
this.* method |
04 |
this.refreshEntityForId(id?) |
this.* method |
04 |
this.refreshTimeline() |
this.* method |
04 |
this.refreshTimelineForId(id?) |
this.* method |
04 |
this.releaseBlockingScript() |
this.* method |
04 · 12 |
release_branches |
manifest field | 03 · 16 |
release_environments |
manifest field | 03 · 16 |
release_notes_directory |
manifest field | 03 |
releaseNotes/<version>.md |
file convention | 16 · 03 · glossary |
required_entitlement |
manifest & service field | 03 · 06 · 16 |
required (step parameter) |
step parameter field | 07 |
routeScripts/<name>/ |
artifact directory | 03 · 12 |
routes (route script) |
route-script config field | 12 |
this.communicate.runBlockScript(blockAPIName, scriptId, args?) |
communicate.* method |
04 · 14 · 09 |
this.runEventScript(scriptName, args?) |
this.* method |
04 · 14 |
this.communicate.runFrameScript(frameAPIName, scriptId, args?) |
communicate.* method |
04 · 14 |
runtime |
step config field | 07 |
scope (service caller restriction) |
service field | 06 |
script_alias |
step parameter field | 07 |
script (step config) |
step config field | 07 |
{{secret.KEY}} templating |
service field syntax | 03 · 06 |
secrets (Python step global) |
Python step global | 07 · 06 |
secrets (step config) |
step config field | 07 |
select (dynamic / async options) |
assistant field type | 13 |
select (static options) |
assistant field type | 13 |
this.communicate.sendMessageToOwnFrame(payload, targetOrigin) |
communicate.* method |
04 · 14 |
| Service account | concept | glossary |
service_name |
service field | 06 |
services |
manifest field | 03 · 03 · 06 · glossary |
services step (assistant) |
assistant section | 13 |
this.sessionData |
this.* data member |
04 · 14 · glossary |
session_data_key (navigation-context query param) |
identifier | 14 |
this.setIndicator(indicator?) |
this.* method |
04 |
this.setSessionData(update) |
this.* method |
04 · 14 |
setup_assistant |
manifest field | 03 · 13 · glossary |
setup_assistant.view / user_setup_assistant.view |
manifest field | 03 · 13 |
| Setup-assistant hash / re-prompt | concept | 13 · glossary |
| Setup view best practices / the five silent failures | concept | 13 |
this.setUserConfig(config) |
this.* method |
04 |
this.show(config?) (floating frame) |
this.* method |
04 |
this.showToast(message, options?) |
this.* method |
04 · 15 |
this.showViewInModal(id, config?) |
this.* method |
04 · 10 |
| Single-painter convention | concept | 09 · 14 |
POST /api/smart-connectors/{connector_identifier}/webhook |
REST endpoint | 05 |
Stage |
step data type | 07 |
step_history_template |
step config field | 07 |
GET /api/team |
REST endpoint | 05 |
GET /api/team/{employee_id} |
REST endpoint | 05 |
POST /api/team/search |
REST endpoint | 05 |
GET /api/team/typeahead |
REST endpoint | 05 |
this.tempPromptState |
this.* data member |
04 |
text (assistant field type) |
assistant field type | 13 |
thumbnail.png |
file convention | 03 · glossary |
title / header_color / header_text_color (floating frame) |
frame config field | 11 |
toolbar_icon / toolbar_color |
page config field | 11 · 10 |
toolbarItems/<name>/ |
artifact directory | 03 · 11 |
tooltip (data adornment) |
adornment config field | 12 |
types (block) |
block config field | 09 |
this.uploadFile(blob, fileName?, isPublic?) |
this.* method |
04 |
this.userConfig |
this.* data member |
04 |
user_setup_assistant |
manifest field | 03 · 13 · glossary |
version |
manifest field | 03 · 16 · glossary |
views/<name>/ |
artifact directory | 03 · 10 |
| View-based setup assistant | concept | 13 · glossary |
this.wait(ms) |
this.* method |
04 |
when |
artifact config field / gating clause | 03 · 07 · 09 · 11 · 12 · 13 · glossary |
width / height (floating frame) |
frame config field | 11 |
*WithErrors tuple convention |
convention | 15 |
| Worker (execution model) | concept | 04 · glossary |