Message catalogue · FinBaze for Platforms

Reference

Generated from the catalogue the API runs on (61 types). See Messages for how routing, acknowledgement and quiet hours work.

Routing values. finbaze_sends: FinBaze emails the user. partner_delivers: you receive message.created and deliver it in your own channels. both. suppress. Types marked fixed cannot be changed (ROUTING_NOT_CHANGEABLE); lifecycle, billing and internal messages are never sent for platform companies.

Account security#

Type	To	Priority	Default for you	Change	Data
`account.email_verification`	company_user, firm_user	critical	`finbaze_sends`	fixed	`verifyUrl: string`, `locale?: string`
`account.membership_invite`	prospect	normal	`suppress`	fixed	`inviteUrl: string`, `resourceName: string`, `permissionLabel: string`, `locale: string`
`account.password_reset`	company_user, firm_user	critical	`finbaze_sends`	fixed	`resetUrl: string`, `locale?: string`

Tax deadlines#

Type	To	Priority	Default for you	Change	Data
`tax_authorisation.revoked`	company_user	normal	`partner_delivers`	any	`companyId: string`, `taxes: string[]`, `revokedVia?: any`, `language: string`
`tax.deadline_upcoming`	company_user	normal (or critical)	`partner_delivers`	any	`filingId: string`, `language: string`, `daysLeft: number`
`tax.filing_accepted`	company_user	normal	`partner_delivers`	any	`filingId: string`, `language: string`
`tax.filing_ready`	company_user	critical	`partner_delivers`	any	`filingId: string`, `language: string`
`tax.filing_rejected`	company_user	critical	`partner_delivers`	any	`filingId: string`, `language: string`, `reason?: string`
`tax.threshold_approaching`	company_user	normal	`partner_delivers`	any	`language: string`, `obligationLabel: string`, `usedAmount: number`, `limitAmount: number`, `taxesUrl: string`
`tax.threshold_exceeded`	company_user	critical	`partner_delivers`	any	`language: string`, `obligationLabel: string`, `usedAmount: number`, `limitAmount: number`, `taxesUrl: string`

Documents#

Type	To	Priority	Default for you	Change	Data
`documents.inbound_unsorted`	external_sender	normal	`finbaze_sends`	`finbaze_sends`, `suppress`	`replyTo: string`, `purchaseEmail: string`, `salesEmail: string`, `lettersEmail: string`, `locale?: any`
`documents.receipt_missing`	company_user	digestible	`partner_delivers`	any	`transactionId: string`
`documents.received_available`	company_user	normal	`partner_delivers`	any	`documentId: string`, `language: string`
`documents.request_digest`	company_user	digestible	`partner_delivers`	any	`language: string`, `isReminder?: boolean`, `requests: object[]`
`documents.request_reminder`	company_user	normal	`partner_delivers`	any	`language: string`, `isReminder?: boolean`, `requests: object[]`

Approvals#

Type	To	Priority	Default for you	Change	Data
`agents.task_waiting_approval`	company_user, firm_user	critical	`partner_delivers`	any	`title: string`, `subject: string`, `body: string`, `replyTo?: string`
`approvals.pay_run_ready`	company_user	critical	`partner_delivers`	any	`payRunId: string`

Sales correspondence#

Type	To	Priority	Default for you	Change	Data
`sales.invoice_payment_failed`	company_customer	normal	`finbaze_sends`	any	`entityId: string`
`sales.invoice_payment_received`	company_customer	normal	`finbaze_sends`	any	`entityId: string`
`sales.invoice_sent`	company_customer	normal, evidence	`finbaze_sends`	any	`entityId: string`
`sales.quote_sent`	company_customer	normal	`finbaze_sends`	any	`entityId: string`
`sales.recurring_invoice`	company_customer	normal	`finbaze_sends`	any	`entityId: string`
`sales.reminder_sent`	company_customer	normal, evidence	`finbaze_sends`	any	`entityId: string`

Payroll correspondence#

Type	To	Priority	Default for you	Change	Data
`payroll.payslip_available`	employee	normal, evidence	`finbaze_sends`	any	`entityId: string`, `language: string`
`payroll.year_document_available`	employee	normal, evidence	`finbaze_sends`	any	`entityId: string`, `language: string`

Ai agents#

Type	To	Priority	Default for you	Change	Data
`agents.task_budget_exhausted`	company_user, firm_user	normal	`partner_delivers`	any	`title: string`, `subject: string`, `body: string`, `replyTo?: string`
`agents.task_completed`	company_user, firm_user	normal	`partner_delivers`	any	`title: string`, `subject: string`, `body: string`, `replyTo?: string`
`agents.task_failed`	company_user, firm_user	normal	`partner_delivers`	any	`title: string`, `subject: string`, `body: string`, `replyTo?: string`
`agents.task_waiting_input`	company_user, firm_user	normal	`partner_delivers`	any	`title: string`, `subject: string`, `body: string`, `replyTo?: string`
`assistant.inbound_reply`	external_sender, company_user	normal	`finbaze_sends`	`finbaze_sends`, `suppress`	`replyTo: string`, `subject: string`, `body: string`, `inReplyTo?: string`, `references?: string[]`

Billing#

FinBaze's own conversation with its customers. Never delivered for platform companies.

Type	To	Priority	Default for you	Change	Data
`billing.firm_client_plan_activated`	firm_user, company_user	normal	`suppress`	fixed	`language: string`, `clientName: string`, `planName: string`, `audience: string`
`billing.firm_client_plan_cancelled`	company_user	normal	`suppress`	fixed	`language: string`, `clientName: string`, `planName: string`, `canceledAt: any`, `accessUntil: any`
`billing.firm_client_subscription_cancelled`	firm_user	normal	`suppress`	fixed	`clientProfileId: string`, `planName: string`, `canceledAt: any`, `accessUntil: any`, `minimumTermEndsAt: any`, `minimumTermMonths: number`
`billing.payroll_addon_enabled`	company_user	normal	`suppress`	fixed	`language: string`, `companyName: string`, `payrollUrl: string`
`billing.plan_upgrade_request`	company_user	normal	`suppress`	fixed	`subject: string`, `body: string`

Lifecycle marketing#

FinBaze's own conversation with its customers. Never delivered for platform companies.

Type	To	Priority	Default for you	Change	Data
`lifecycle.founder_checkin`	company_user	normal	`suppress`	fixed	`language: string`, `meetingUrl: string`, `unsubscribeUrl: string`, `signatureName: string`, `from: object`
`lifecycle.onboarding_resume`	company_user	normal	`suppress`	fixed	`language: string`, `copyKey: string`, `buttonUrl: string`, `unsubscribeUrl: string`
`lifecycle.plan_welcome`	company_user	normal	`suppress`	fixed	`language: string`, `companyName: string`, `planName: string`, `trialDays: number`, `trialEndsAt: any`, `dashboardUrl: string`, `firstName?: any`
`lifecycle.platform_onboarding_invite`	prospect	normal	`suppress`	fixed	`inviteUrl: string`, `contactName?: any`, `message?: any`, `locale?: string`
`lifecycle.practice_invoice`	company_user	normal	`suppress`	fixed	`profileId: string`
`lifecycle.setup_step`	company_user	normal	`suppress`	fixed	`language: string`, `copyKey: string`, `buttonUrl: string`, `unsubscribeUrl: string`

Banking#

Type	To	Priority	Default for you	Change	Data
`banking.lunchflow_consent`	company_user	normal	`partner_delivers`	any	`language: string`, `variant: string`, `accountNames: string[]`, `reconnectUrl: string`

Insights#

Type	To	Priority	Default for you	Change	Data
`insights.budget_run_rate_digest`	company_user	digestible	`partner_delivers`	any	`language: string`, `items: object[]`, `budgetsUrl: string`
`platform_ops.alert`	platform_ops	normal	`suppress`	fixed	`platformName: string`, `title: string`, `detail: string`, `severity: string`, `portalUrl: string`, `locale?: string`

Firm relations#

Type	To	Priority	Default for you	Change	Data
`company.transfer_claim`	prospect	normal	`finbaze_sends`	fixed	`claimUrl: string`, `companyName: string`, `platformName: string`, `language?: string`
`firm.access_requested`	company_user	normal	`partner_delivers`	any	`engagementId: string`, `firmId: string`, `firmName: string`, `message?: any`, `contactEmail?: any`, `expiresAt: any`, `language?: string`
`firm.client_connect_invite`	company_user	normal	`partner_delivers`	any	`connectUrl: string`, `language?: string`
`firm.client_hmrc_removal_notice`	company_user	normal	`suppress`	fixed	`previousBookkeeperName: string`, `newBookkeeperName: string`, `hmrcServices: string[]`
`firm.client_onboarding_invite`	prospect	normal	`suppress`	fixed	`joinUrl: string`, `language?: string`
`firm.client_onboarding_resume`	prospect	normal	`suppress`	fixed	`joinUrl: string`, `language?: string`
`firm.client_transferred_away`	firm_user	normal	`finbaze_sends`	fixed	`clientProfileId: string`, `newBookkeeperName: string`, `hmrcServices?: string[]`
`firm.engagement_company_notice`	company_user	normal	`partner_delivers`	any	`kind: string`, `engagementId: string`, `firmId: string`, `firmName: string`, `taxes: string[]`, `reason?: any`, `endsAt?: any`, `hmrcServices?: string[]`, `language?: string`
`firm.engagement_firm_notice`	firm_user	normal	`finbaze_sends`	fixed	`kind: string`, `engagementId: string`, `companyId: string`, `companyName: string`, `platformName: string`, `taxes: string[]`, `reason?: any`, `endsAt?: any`, `language?: string`
`support.access_requested`	company_user	normal	`partner_delivers`	any	`grantId: string`, `reason: string`, `scope: string`, `durationMinutes: number`, `title?: string`, `summary?: string`, `language?: string`

Custom#

Type	To	Priority	Default for you	Change	Data
`custom.automation_email`	company_user, company_customer	normal	`finbaze_sends`	any	`subject: string`, `heading: string`, `body: string`
`custom.automation_whatsapp`	company_user, company_customer	normal	`suppress`	`suppress`, `finbaze_sends`	`text: string`
`custom.notification`	company_user, firm_user	normal	`partner_delivers`	any	`sender: any`, `subject: string`, `body: string`, `replyTo?: any`
`purchase.order_sent`	company_customer	normal, evidence	`finbaze_sends`	`finbaze_sends`, `suppress`	`purchaseOrderId: string`, `subject: string`, `heading: string`, `body: string`, `replyTo?: any`
`purchase.supplier_email`	company_customer	normal	`finbaze_sends`	`finbaze_sends`, `suppress`	`subject: string`, `body: string`, `replyTo?: any`

Internal#

FinBaze's own conversation with its customers. Never delivered for platform companies.

Type	To	Priority	Default for you	Change	Data
`internal.plan_subscribed`	finbaze_internal	normal	`suppress`	fixed	`companyName: string`, `legalName: string`, `planName: string`, `priceCents: number`, `dashboardUrl: string`, `trialEndsAt: any`
`internal.support_escalation`	finbaze_internal	normal	`suppress`	fixed	`kind: string`, `escalationId: string`, `platformName: string`, `subject: string`, `severity: string`, `source: string`, `description: string`, `adminUrl: string`, `companyName?: any`, `comment?: any`, `requestIds?: string[]`, `screen?: any`, `contactEmail?: any`