Skip to content

Types

Common

OperationResult

FieldTypeDescription
-{} or empty response bodyThe endpoint completed successfully.

TokenResponse

FieldTypeDescription
tokenstringBearer token for subsequent API/MCP requests.

AvatarUploadResult

FieldTypeDescription
urlstringUploaded avatar URL.
fileNamestringStored file name.
extensionstringFile extension.
sizenumberFile size in bytes.

TagsAndLabels

FieldTypeDescription
tagsstring[]Short tags for filtering and grouping.
labelsRecord<string, string>Machine-readable labels.

Account

Me

FieldTypeDescription
idstringId account.
newidstringCompatible legacy account id field.
tier"free" | "advanced" | "pro"Current account tier.
settingsobjectAccount settings.
meta.nicknamestringAccount display name.
meta.avatarstring?Account avatar URL.
token.identitystringIdentity bound to the current token.
workspaceWorkspaceView | nullCurrently selected workspace.
membershipsUserMembership[]Workspaces where the account is a member.
addressbookAddressEntry[]Addresses from the current workspace/account context.
subscriptionsRecord<string, number>Subscription counters by source/project key.
counters.subscriptionsSubscriptionCounter[]Aggregated subscription counters.

UserMembership

FieldTypeDescription
idstringId membership/ACL entry.
level"owner" | "admin" | "developer" | "user"Role in the workspace.
workspaceWorkspaceViewShortWorkspace for this membership.

AccountSettings

FieldTypeDescription
-objectSettings object for the current UI version. The field set may expand.

CurrentWorkspaceResponse

FieldTypeDescription
workspaceWorkspaceView | nullCurrently selected workspace or null.

Workspaces

WorkspaceView

FieldTypeDescription
idstringId workspace.
fullnamestringUnique workspace name.
invitestring?Invite token. Returned only when the caller can see the private workspace data.
tagsstring[]Tags.
labelsRecord<string, string>Labels.
meta.titlestring?Visible workspace title.
meta.avatarstring?Workspace avatar URL.

WorkspaceViewShort

FieldTypeDescription
idstringId workspace.
fullnamestringWorkspace fullname.
tagsstring[]Tags.
labelsRecord<string, string>Labels.
metaobject?Workspace metadata.

WorkspaceAclEntry

FieldTypeDescription
idstringId ACL entry.
level"owner" | "admin" | "developer" | "user"Role.
userUserViewShortUser if the entry is already linked to an account.
object{ type: string, id: string }?Workspace reference. May be present in the raw ACL response.
subject{ type: string, id: string }?User/invite reference. May be present in the raw ACL response.

Projects

ProjectView

FieldTypeDescription
idstringId project.
createdAtstring?Creation date in ISO format.
updatedAtstring?Update date in ISO format.
createdByAccountIdstring?Owner account id.
billingAccountIdstring?Billing owner account id.
namestringProject name inside the workspace.
fullnamestringCanonical project fullname.
workspacestringOwner workspace fullname.
publicbooleanLegacy public flag.
visibility"public" | "private_link" | "personal"?Storage visibility.
accessLevel"private" | "public" | "free"?Product access level.
tagsstring[]Tags.
labelsRecord<string, string>Labels.
meta.titlestringVisible title.
meta.descriptionstringFull description.
meta.shortDescriptionstring?Short description.
meta.links{ title: string, url: string }[]?Useful links.
meta.iconstring?URL icon.
meta.avatarstring?Avatar URL, usually the same as icon.
meta.coverstring?URL cover.
ownerTitlestring?Visible workspace/account owner title.
triggerLimits.maxProvidersPerTriggernumber | nullProvider weight limit per trigger. The field name is preserved for API compatibility.

ProjectCreateCapability

FieldTypeDescription
tier"free" | "advanced" | "pro"Current account tier.
canCreateProjectsbooleanWhether a project can be created.
privateProjectsUsednumberHow many private projects already count toward the limit.
privateProjectsLimitnumber | nullPrivate projects limit; null means unlimited.
canCreatePrivateProjectsbooleanWhether a private project can be created within the limit.
FieldTypeDescription
tokenstringAccess link token.
projectstringProject fullname.
maxUsagesnumber?Maximum number of uses.
usagesnumber?Current number of uses.
expiresAtstring?Expiration date in ISO format.
createdAtstring?Creation date in ISO format.

ProjectImageUploadResult

FieldTypeDescription
urlstringUploaded image URL.
fileNamestringStored file name.
extensionstringFile extension.
sizenumberFile size in bytes.

Project Transfers

ProjectTransferPlan

FieldTypeDescription
mode"dry-run"Plan preview mode.
sourceProjectTransferProjectRefSource project.
targetProjectTransferTargetRefTarget workspace, name, and fullname.
countsProjectTransferCountsCounters for what will be transferred.
changesProjectTransferChangesDetailed list of planned changes.
conflictsProjectTransferConflict[]Blocking conflicts.
notesstring[]Additional notes.
planHashstring?Plan hash, if the request creation endpoint returns it with the plan.

ProjectTransferCounts

FieldTypeDescription
triggersnumberTriggers to transfer.
templatesnumberTemplate records to transfer.
templateGroupsnumberTemplate groups.
templateTopicsnumberTemplate topics.
subscriptionsnumberSubscriptions whose references will be affected.
scopedEntitiesnumberApps/actions/resources/types/blueprints scoped to the project.
projectAccessLinksnumberAccess links to update.
aliasWritesnumberEntity aliases to create or update.
aliasMissingnumberMissing aliases to create.
aliasStalenumberStale aliases to update.
conflictsnumberNumber of conflicts.

ProjectTransferRequest

FieldTypeDescription
idstringId request.
sourceProjectIdstringSource project id.
sourceProjectFullnamestringSource project fullname.
sourceWorkspacestringSource workspace fullname.
targetWorkspacestringTarget workspace fullname.
targetNamestringProject name in the target workspace.
targetFullnamestringProject fullname in the target workspace.
status"pending" | "accepted" | "rejected" | "cancelled" | "expired" | "failed"Request status.
requestedByAccountIdstringAccount that created the request.
sourceOwnerAccountIdstringCurrent source owner account.
targetOwnerAccountIdstringTarget owner account.
planHashstringAccepted plan hash.
planCountsRecord<string, number>Snapshot of plan counters.
expiresAtstringExpiration date in ISO format.
createdAtstringCreation date in ISO format.
updatedAtstringUpdate date in ISO format.
decidedAtstring?Decision date in ISO format.
decidedByAccountIdstring?Account that accepted, rejected, or cancelled the request.
appliedAtstring?Apply date in ISO format.
rejectedReasonstring?Rejection reason.
failureReasonstring?Failure reason.

ProjectTransferAcceptResult

FieldTypeDescription
requestProjectTransferRequestAccepted request.
transferProjectTransferApplyResultDetails of the applied transfer.

ProjectTransferApplyResult

FieldTypeDescription
mode"apply"Apply mode.
appliedAtstringApply date in ISO format.
writes.projectsnumberUpdated project records.
writes.triggersnumberUpdated triggers.
writes.triggerProvidersnumberUpdated trigger providers.
writes.triggerTransformsnumberUpdated trigger transforms.
writes.templatesnumberUpdated templates.
writes.subscriptionsnumberUpdated subscriptions.
writes.scopedEntitiesnumberUpdated entities scoped to the project.
writes.projectAccessLinksnumberUpdated access links.
writes.aliasesnumberWritten aliases.

Triggers

TriggerView

FieldTypeDescription
idstringTrigger id.
createdAtstring?Creation date in ISO format.
updatedAtstring?Update date in ISO format.
namestringTrigger name inside the project.
fullnamestringCanonical trigger fullname.
projectIdstring?Id project.
projectstringProject fullname.
workspacestringWorkspace fullname.
publicbooleanLegacy public flag.
backend{ type: "sdk", trigger: string, values?: object }Backend runtime reference.
inputsRecord<string, TypeSchema>Required subscription inputs.
defaultsEventDefaults?Recommended notification defaults.
outputRecord<string, TypeSchema>?Legacy output schema.
triggerSpecTriggerSpec?Source matching specification.
filtersSchemaRecord<string, TriggerOutputSchemaField>?Optional subscription filters.
outputSchemaRecord<string, TriggerOutputSchemaField>?Raw/human output schema.
activationTriggerActivation | null?Optional activation condition.
executionPolicyobject?Runtime policy overrides.
statusTriggerStatusDetailsTest/runtime status.
tagsstring[]Tags.
labelsRecord<string, string>Labels.
meta.titlestringVisible title.
meta.descriptionstring?Description.
hasProvidersboolean?true if providers exist.
hasTransformboolean?true if transform exists.

TriggerDraftView

FieldTypeDescription
providersTriggerProvider[]?Full provider definitions.
transformTriggerTransform?JavaScript raw/human transform.

TriggerStatusDetails

FieldTypeDescription
status"not_tested" | "ready" | "broken"Current status.
issuestring?Human-readable issue.
source"edit" | "test" | "runtime" | "dependency"?Status source.
updatedAtstring?Update date in ISO format.

TriggerSpec

VariantMain fields
evm_logtype, dataSource, optionally contract, event, abiFragment, topicsCount, dataBytes, testInput.
evm_transactiontype, dataSource, optionally testInput.
substrate_eventtype, dataSource, optionally pallet, event, testInput.
timertype, interval, optionally testInput.

TriggerTransform

FieldTypeDescription
language"javascript"Transform language.
sourcestring?Legacy source.
rawSourcestring?Transform to raw output.
humanSourcestring?Transform raw output to human output.

TriggerActivation

FieldTypeDescription
language"javascript"Activation language.
sourcestringJavaScript condition source code.

TriggerValidationResult

FieldTypeDescription
validbooleanWhether the draft is valid.
issuesstring[]Validation issues.
triggerTriggerDraftView?Normalized trigger draft if the endpoint returns it.

TriggerPatchResult

FieldTypeDescription
fullnamestringTrigger fullname.
dryRunboolean?true if changes were only validated.
updatedbooleanWhether the trigger was changed.
changedPathsstring[]Dotted paths that were changed.
triggerTriggerDraftViewTrigger after patch or normalized dry-run view.

TriggerBulkPatchResult

FieldTypeDescription
dryRunboolean?true if the bulk patch was a dry run.
totalCountnumberNumber of processed items.
updatedCountnumberNumber of changed items.
itemsTriggerBulkPatchItem[]Results by trigger.

TriggerBulkPatchItem

FieldTypeDescription
fullnamestringTrigger fullname.
dryRunboolean?true if the item was a dry run.
updatedbooleanWhether the trigger was changed.
changedPathsstring[]Changed paths.
statusstring?Trigger status after patch.
statusUpdatedAtstring?Status update date.
unsetPathsstring[]Paths that were removed.

TriggerBulkRemoveResult

FieldTypeDescription
dryRunboolean?true if the bulk remove was a dry run.
totalCountnumberNumber of processed triggers.
deletedCountnumberNumber of removed triggers.
itemsTriggerBulkRemoveItem[]Results by trigger.

TriggerBulkRemoveItem

FieldTypeDescription
fullnamestringTrigger fullname.
dryRunboolean?true if the item was a dry run.
deletedbooleanWhether the trigger was removed.
projectstringProject fullname.
workspacestringWorkspace fullname.

TriggerPreviewResult

FieldTypeDescription
validbooleanWhether preview succeeded.
issuesstring[]Issues.
outputunknown?Output preview.
debugRecord<string, unknown>?Debug details.

TriggerTestResult

FieldTypeDescription
validbooleanWhether the test succeeded.
issuesstring[]Test issues.
inputunknown?Source item used for the test.
outputunknown?Raw/human output.
sourceEventsCountnumber?Number of found source items.
debugRecord<string, unknown>?Debug details.

ProviderTestResult

FieldTypeDescription
validbooleanWhether the provider test succeeded.
issuesstring[]Issues.
resultunknown?Provider output.
debugRecord<string, unknown>?Debug details.

RuntimeSource

FieldTypeDescription
appstringRuntime app name.
networkstringNetwork/source name.
plugin"evm" | "substrate"Runtime plugin type.
instancestringRuntime instance.
status"running" | "degraded" | "error"Runtime status.
updatedAtstringUpdate date in ISO format.
latestSeenBlocknumber?Last block seen by runtime.
lastProcessedBlocknumber?Last processed block.
blockLagnumber?Current block lag.
lastFailedBlocknumber?Last failed block.
errorsLastHournumber?Error count in the last hour.

LatestBlockResult

FieldTypeDescription
validbooleanWhether lookup succeeded.
issuesstring[]Lookup issues.
latestBlocknumber?Found latest block.
matchedbooleanWhether a matching source item was found.
matchedBlocknumber?Block where the match was found.
checkedBlocksnumberNumber of checked blocks.
sourceEventsCountnumber?Source event count.
itemIndexnumber?Found item index.
inputunknown?Found input.
sourcestring?Lookup source.
detailsunknown?Additional details.

Trigger Import

EvmAbiImportResult

FieldTypeDescription
eventsunknown[]?Parsed ABI event entries.
callsunknown[]?Parsed ABI call/function entries.
itemsunknown[]?Unified list of parsed entries if runtime returns a flat list.
errorstring?Error message if runtime could not parse ABI.

EvmAbiResult

FieldTypeDescription
abiunknown[]?ABI JSON entries if ABI was loaded.
sourcestring?ABI source marker.
contractstring?Contract address.
errorstring?Error message if ABI could not be loaded.

TriggerImportDraftsResult

FieldTypeDescription
abiSource"provided" | "auto"?ABI source used for EVM import.
draftsTriggerDraftView[]Generated trigger drafts.

SubstrateSourceInfo

FieldTypeDescription
ss58PrefixnumberSS58 prefix for the Substrate source.

SubstratePalletSummary

FieldTypeDescription
namestringPallet name.
docsstring[]Pallet documentation.
hasEventsbooleanWhether the pallet has events.
hasCallsbooleanWhether the pallet has calls.
eventCountnumberNumber of events.
callCountnumberNumber of calls.

Templates

ProjectTemplate

FieldTypeDescription
idstringId template.
projectstringProject fullname.
schemaRecord<string, TypeSchema>Template-level input schema.
groupsTemplateGroup[]Groups shown to users as templates.
topicsTemplateTopic[]Topics inside groups.
rulesTemplateRule[]Trigger rules for topics.
metaRecord<string, unknown>Template metadata.
issuestring?Template sync issue.

TemplateGroup

FieldTypeDescription
namestringGroup id.
meta.titlestringVisible title.
meta.descriptionstringDescription.

TemplateTopic

FieldTypeDescription
namestringId topic.
groupstringParent group id.
selectedByDefaultbooleanWhether the topic is selected by default in the subscription wizard.
meta.titlestringVisible title.

TemplateRule

FieldTypeDescription
idstringRule id.
triggerstringTrigger fullname.
topicstringTopic name.
inputsobject?Input mapping/defaults for the rule.
policyobject?Execution policy.
conditionsCondition | null?Condition rule.
deprecatedbooleanWhether the rule is marked as deprecated.
requiredValuesstring[]Required template values.
issuestring?Missing trigger or sync issue.

Subscriptions

SubscriptionView

FieldTypeDescription
idstringId subscription.
targetWorkspaceFullnamestring?Workspace that owns the subscription.
createdByAccountIdstring?Account that created the subscription.
sourceProjectIdstring?Source project id.
sourceProjectFullnamestring?Source project fullname.
countsTowardsTierQuotaboolean?Whether the subscription counts toward the Free tier quota.
state"on" | "off" | "blocked"Subscription state.
createdAtstringCreation date in ISO format.
updatedAtstringUpdate date in ISO format.
templateSubscriptionTemplateReference | nullTemplate reference or null for a direct trigger subscription.
rulesSubscriptionRule[]Trigger rules.
resourcesstring[]Resource fullnames used by actions.
actionsSubscriptionAction[]?Notification actions.
referencesSubscriptionReferencesDenormalized references to source/project/trigger.
meta.titlestring?Visible title.
meta.issuestring?Block/entitlement/migration issue.

SubscriptionTemplateReference

FieldTypeDescription
idstringId template.
inputsRecord<string, string | number>Template input values.
groups{ name: string, meta: { title: string } }[]Selected groups.
topicsstring[]Selected topics.
rules{ id: string, group: string }[]Selected rule references.

SubscriptionRule

FieldTypeDescription
triggerIdstring?Trigger id.
triggerRuleTriggerReferenceTrigger reference.
inputsobject?Input values.
policyobject?Execution policy.
conditionsCondition | null?Condition rule.

SubscriptionAction

FieldTypeDescription
actionstringAction fullname.
valuesRecord<string, unknown>Action values.
overridesEventDefaults?Notification override fields.

SubscriptionReferences

FieldTypeDescription
sourcesstring[]References to data sources.
projectsstring[]Project fullnames.
triggersstring[]Trigger fullnames.
projectIdsstring[]?Project ids.
triggerIdsstring[]?Trigger ids.

SubscriptionTestResult

FieldTypeDescription
validbooleanWhether the test is valid.
issuesstring[]Test issues.
previewunknown?Notification preview/send result.
subscriptionSubscriptionView?Draft subscription used for the test.

SubscriptionAlertLog

FieldTypeDescription
idstringLog id.
subscriptionIdstringId subscription.
workspaceIdstringId workspace.
projectFullnamestring?Project fullname.
triggerFullnamestring?Trigger fullname.
eventNamestringEvent/trigger name.
createdAtstringCreation date in ISO format.
status"delivered" | "failed" | "rate_limited" | "blocked"Delivery status.
testInputRecord<string, unknown>?Test input.
itemIndexnumber?Source item index.
replayMatch{ hash?: string | null, index?: number | null }?Replay match information.
sourceItemsCountnumber?Number of source items.
channelsSubscriptionAlertLogChannel[]Delivery channels.
failureReasonCodestring?Error code.
failureReasonMessagestring?Error message.
expireAtstringLog expiration date.

Resources

ResourceView

FieldTypeDescription
idstringId resource.
namestringResource name.
fullnamestringResource fullname.
projectstring?Project fullname.
workspacestringWorkspace fullname.
publicbooleanPublic flag.
blueprintstringBlueprint fullname.
tokenstring?Secret token. Returned only when the caller can see private resource fields.
readybooleanWhether the resource is ready.
remarkstring | nullResource status remark.
dataobject | null?Resource setup data.
tagsstring[]Tags.
labelsRecord<string, string>Labels.
meta.titlestring?Visible title.

ExternalResourceView

FieldTypeDescription
blocks{ type: "markdown", text: string }[]UI content blocks returned by the external app.

Data Sources

CustomSourceListView

FieldTypeDescription
workspacestringOwner workspace fullname.
namestringSource name.
fullnamestringSource fullname.
publicbooleanPublic flag.
kind"evm" | "substrate"Source type.
metaCustomSourceMetaMetadata.
createdAtstringCreation date in ISO format.
updatedAtstringUpdate date in ISO format.
deployerTitlestring?Visible deployer/owner title.

CustomSource

FieldTypeDescription
createdByAccountIdstring?Creator account id.
endpointsstring[]Runtime RPC endpoints.
substrateobject?Substrate extensions/types/RPC config.
batchMaxCountnumber?Maximum EVM batch size.
blockProcessingConcurrencynumber?Block processing concurrency.
maxQueuedBlocksnumber?Maximum queued blocks.
logs{ retentionMs: number, maxCount: number | null }?Policy log runtime.
runtimeCustomSourceRuntimeMetadata?Runtime metadata.

CustomSourceMeta

FieldTypeDescription
titlestringVisible title.
descriptionstring?Description.
icons.defaultstring?Default icon URL.
ogobject?OpenGraph metadata.

CustomSourceRuntimeMetadata

FieldTypeDescription
evm.chainIdnumber?EVM chain id.
evm.latestBlocknumber?Latest EVM block.
evm.blockHashstring?Block hash.
evm.fetchedAtstringMetadata fetch date.
substrate.ss58Prefixnumber?SS58 prefix.
substrate.latestBlocknumber?Latest Substrate block.
substrate.fetchedAtstringMetadata fetch date.

CustomSourceCreateCapability

FieldTypeDescription
tier"free" | "advanced" | "pro"Account tier.
canCreateCustomSourcesbooleanWhether the current account can create custom sources.
customSourcesUsednumberCurrent number of private custom sources.
customSourcesLimitnumber | nullLimit; null means unlimited.

CustomSourceVerifyResult

FieldTypeDescription
okbooleanWhether verification succeeded.
logs{ level: "info" | "error", message: string }[]Verification log messages.
detailsRecord<string, unknown>?Runtime/public duplicate check details.
errorstring?Verification error.

CustomSourceLogsResult

FieldTypeDescription
existsbooleanWhether the log file exists.
linesstring[]Edited log lines.
truncatedbooleanWhether output was truncated.
updatedAtstring?Log file update date.

CustomSourceRuntimeActionResult

FieldTypeDescription
oktrueWhether the runtime action succeeded.
sourceFullnamestringSource fullname.
revisionnumberRuntime revision after restart/reset.

CustomSourceResetLagResult

FieldTypeDescription
oktrueWhether reset succeeded.
latestBlocknumberLast block used as the new lag baseline.

CustomSourceStatusTestResult

FieldTypeDescription
oktrueTest event sent.
eventNamestringGenerated status trigger name.
subscriptionsTestednumberTested subscriptions.
matchednumberNumber of matched subscriptions.
deliverednumberDelivered alerts.
eventCustomSourceStatusEventTest status event.

CustomSourceStatusEvent

FieldTypeDescription
type"status_changed" | "error" | "recovered"Event type.
sourceFullnamestringSource fullname.
sourceNamestringSource name.
sourceTitlestringVisible title.
workspacestringWorkspace fullname.
kind"evm" | "substrate"Source type.
status"running" | "error" | "degraded"New status.
previousStatus"running" | "error" | "degraded"?Previous status.
severity"info" | "warning" | "error"Severity.
messagestringHuman-readable message.
codestring?Machine-readable code.
detailsRecord<string, unknown>?Additional details.
timestampstringEvent time in ISO format.

Addresses

AddressEntry

FieldTypeDescription
idstringId address entry.
type"plain" | "ss58" | "evm" | "bitcoin" | "cosmos"Type address.
addressstringAddress value.
aliasstringVisible alias.

Builder Registry

AppView

FieldTypeDescription
idstringId app.
namestringApp name.
fullnamestringApp fullname.
projectstringProject fullname.
workspacestringWorkspace fullname.
publicbooleanPublic flag.
urlstring?App URL. Returned only when the caller can see private fields.
tagsstring[]Tags.
labelsRecord<string, string>Labels.

ActionView

FieldTypeDescription
idstringId action.
namestringAction name.
fullnamestringAction fullname.
projectstringProject fullname.
workspacestringWorkspace fullname.
publicbooleanPublic flag.
backend{ type: "sdk", action: string }Action backend.
valuesRecord<string, TypeSchema>Action values schema.
overridesArray<keyof EventDefaults>Notification fields the action can override.
tagsstring[]Tags.
labelsRecord<string, string>Labels.
meta.titlestringVisible title.
meta.descriptionstring?Description.

BlueprintView

FieldTypeDescription
idstringId blueprint.
namestringBlueprint name.
fullnamestringBlueprint fullname.
appstringApp fullname.
projectstringProject fullname.
workspacestringWorkspace fullname.
publicbooleanPublic flag.
typestringBlueprint type.
dataobject?Blueprint object spec.
tagsstring[]Tags.
labelsRecord<string, string>Labels.
meta.titlestring?Visible title.
meta.descriptionstring?Description.

SharedTypeView

FieldTypeDescription
idstringId shared type.
namestringShared type name.
fullnamestringShared type fullname.
projectstringProject fullname.
workspacestringWorkspace fullname.
publicbooleanPublic flag.
schemasRecord<string, TypeSchema>Named schemas.
tagsstring[]Tags.
labelsRecord<string, string>Labels.
meta.titlestring?Visible title.
meta.descriptionstring?Description.

Supporting Types

EventDefaults

FieldTypeDescription
titlestring?Notification title template.
shortstring?Short markdown text template.
longstring?Long markdown text template.
iconstring | null?Icon URL template.
coverstring | null?Cover URL template.
avatarstring | null?Avatar URL template.
links{ title: string, url: string }[]?Notification links.