Better Helpdesk
Inbox and team

Inboxes

Every field of InboxConfig and BusinessHours, the per-inbox settings under the inboxes option.

inboxes in the configuration maps a key to an InboxConfig. The key is what conversations store in their inbox column and what the widget's inbox prop names. Every field is optional, so {} is a valid inbox. Related guide: Set up inboxes.

lib/helpdesk.ts
inboxes: {
  support: { receipt: true, reminderAfterHours: 4 },
  sales: {
    public: true,
    allowedOrigins: ['https://www.example.com'],
    defaultPriority: 'high',
  },
},

InboxConfig

Prop

Type

An anonymous visitor who writes to the inbox keyed sales gets a contact in the first of leadStages, or in no stage when the list is empty.

BusinessHours

Wall-clock spans per weekday in one time zone.

Prop

Type

buildHelpdesk throws when hours breaks any of these rules:

  • timeZone names a time zone the runtime knows.
  • A start is HH:MM from 00:00 to 23:59. An end is the same or 24:00, which ends the span at midnight.
  • At least one day has a span.
  • No key other than the seven day keys.
  • Each closed entry is a real calendar date.

A span whose end is not after its start runs into the next day.

lib/helpdesk.ts
support: {
  reminderAfterHours: 4,
  hours: {
    timeZone: 'Europe/Zurich',
    weekly: {
      mon: [['08:00', '12:00'], ['13:00', '17:00']],
      tue: [['08:00', '17:00']],
      wed: [['08:00', '17:00']],
      thu: [['08:00', '17:00']],
      fri: [['08:00', '15:00']],
    },
  },
},

With these hours a customer who writes at 14:00 on a Friday has waited four open hours at 11:00 on Monday.

On this page