Skip to content
Bkper
app.header.homeapp.header.docs

App

Extends

  • App

Properties

apiVersion?

optional apiVersion: "v0" | "v1" | "v2" | "v3" | "v4" | "v5";

The API version of the event payload

Inherited from

bkper.App.apiVersion

clientId?

optional clientId: string;

The Google OAuth Client ID

Inherited from

bkper.App.clientId

clientSecret?

optional clientSecret: string;

The Google OAuth Client Secret

Inherited from

bkper.App.clientSecret

connectable?

optional connectable: boolean;

Tell if this app is connectable by a user

Inherited from

bkper.App.connectable

deprecated?

optional deprecated: boolean;

Tell if the code app is deprecated

Inherited from

bkper.App.deprecated

description?

optional description: string;

The App description

Inherited from

bkper.App.description

developers?

optional developers: string;

The developers (usernames and domain patterns), comma or space separated

Inherited from

bkper.App.developers

events?

optional events: (
  | "FILE_CREATED"
  | "FILE_UPDATED"
  | "TRANSACTION_CREATED"
  | "TRANSACTION_UPDATED"
  | "TRANSACTION_DELETED"
  | "TRANSACTION_POSTED"
  | "TRANSACTION_CHECKED"
  | "TRANSACTION_UNCHECKED"
  | "TRANSACTION_RESTORED"
  | "ACCOUNT_CREATED"
  | "ACCOUNT_UPDATED"
  | "ACCOUNT_DELETED"
  | "QUERY_CREATED"
  | "QUERY_UPDATED"
  | "QUERY_DELETED"
  | "GROUP_CREATED"
  | "GROUP_UPDATED"
  | "GROUP_DELETED"
  | "COMMENT_CREATED"
  | "COMMENT_DELETED"
  | "COLLABORATOR_ADDED"
  | "COLLABORATOR_UPDATED"
  | "COLLABORATOR_REMOVED"
  | "INTEGRATION_CREATED"
  | "INTEGRATION_UPDATED"
  | "INTEGRATION_DELETED"
  | "BOOK_CREATED"
  | "BOOK_AUDITED"
  | "BOOK_UPDATED"
  | "BOOK_DELETED")[];

Event types the App listen to

Inherited from

bkper.App.events

filePatterns?

optional filePatterns: string[];

File patters the App handles - wildcard accepted - E.g *.pdf *-bank.csv

Inherited from

bkper.App.filePatterns

id?

optional id: string;

The unique agent id of the App - this can’t be changed after created

Inherited from

bkper.App.id

installable?

optional installable: boolean;

Tell if this app is installable in a book

Inherited from

bkper.App.installable

logoUrl?

optional logoUrl: string;

The App logo url

Inherited from

bkper.App.logoUrl

logoUrlDark?

optional logoUrlDark: string;

The App logo url in dark mode

Inherited from

bkper.App.logoUrlDark
optional menuPopupHeight: string;

The menu popup window height

Inherited from

bkper.App.menuPopupHeight
optional menuPopupWidth: string;

The menu popup window width

Inherited from

bkper.App.menuPopupWidth
optional menuText: string;

The contex menu text - default to the App name

Inherited from

bkper.App.menuText
optional menuUrl: string;

The context menu url

Inherited from

bkper.App.menuUrl
optional menuUrlDev: string;

The context menu url in dev mode

Inherited from

bkper.App.menuUrlDev

name?

optional name: string;

The App name

Inherited from

bkper.App.name

ownerEmail?

optional ownerEmail: string;

The owner user email

Inherited from

bkper.App.ownerEmail

ownerId?

optional ownerId: string;

The owner user id

Inherited from

bkper.App.ownerId

ownerLogoUrl?

optional ownerLogoUrl: string;

The owner company logo url

Inherited from

bkper.App.ownerLogoUrl

ownerName?

optional ownerName: string;

The owner company name

Inherited from

bkper.App.ownerName

ownerWebsite?

optional ownerWebsite: string;

The owner company website url

Inherited from

bkper.App.ownerWebsite

propertiesSchema?

optional propertiesSchema: AppPropertiesSchema;

Inherited from

bkper.App.propertiesSchema

published?

optional published: boolean;

Tell if this app already published

Inherited from

bkper.App.published

readme?

optional readme: string;

The readme.md file as string

Inherited from

bkper.App.readme

readmeMd?

optional readmeMd: string;

The readme.md file as raw markdown string

Inherited from

bkper.App.readmeMd

repoPrivate?

optional repoPrivate: boolean;

Tell if the code repository is private

Inherited from

bkper.App.repoPrivate

repoUrl?

optional repoUrl: string;

The code repository url

Inherited from

bkper.App.repoUrl

scopes?

optional scopes: string[];

The Google OAuth Scopes used by the app

Inherited from

bkper.App.scopes

users?

optional users: string;

The users (usernames and domain patterns) to enable the App while not yet published

Inherited from

bkper.App.users

webhookUrl?

optional webhookUrl: string;

The Webhook endpoint URL to listen for book events

Inherited from

bkper.App.webhookUrl

webhookUrlDev?

optional webhookUrlDev: string;

The Webhook endpoint URL to listen for book events in dev mode

Inherited from

bkper.App.webhookUrlDev

website?

optional website: string;

The App website url

Inherited from

bkper.App.website