User
Inbox Knowledge Base
Screen guide
Before you start
Use the account and workspace that own the relevant records. The feature also needs to be enabled for this installation and plan.
Open this feature
- Open /portal/inbox/knowledge-base on your site.
Steps
Choose a task
Create or update: Save changes / Save draft / Save for review
- Open /portal/inbox/knowledge-base on your application domain, using the workspace account for this task.
- Find the form containing Title / e.g. How to change a subscription, Answer / guidance / Write the answer your team should give. Include useful steps, exceptions and links., Short summary / One sentence that makes this article easy to find.. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Use the button shown for the current state: Save changes, Save draft, Save for review. Creation and editing can show different labels; submit the form once.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| Title / e.g. How to change a subscription | Enter the title / e.g. how to change a subscription for this task, using the help or example shown by the form. The form’s example is e.g. How to change a subscription. Replace it with your own value. Maximum 255 characters. |
| Answer / guidance / Write the answer your team should give. Include useful steps, exceptions and links. | Enter the answer / guidance / write the answer your team should give. include useful steps, exceptions and links. for this task, using the help or example shown by the form. The form’s example is Write the answer your team should give. Include useful steps, exceptions and links.. Replace it with your own value. Maximum 60000 characters. |
| Short summary / One sentence that makes this article easy to find. | Enter the short summary / one sentence that makes this article easy to find. for this task, using the help or example shown by the form. The form’s example is One sentence that makes this article easy to find.. Replace it with your own value. Maximum 1000 characters. |
| Choose or add a category | Enter the choose or add a category for this task, using the help or example shown by the form. Maximum 120 characters. |
| billing, refund, delivery | Enter the billing, refund, delivery for this task, using the help or example shown by the form. The form’s example is billing, refund, delivery. Replace it with your own value. Maximum 600 characters. |
| Optional reference | Enter the optional reference for this task, using the help or example shown by the form. The form’s example is Optional reference. Replace it with your own value. Maximum 2000 characters. |
Create or update: Read & preview / Reading…
- Open /portal/inbox/knowledge-base on your application domain, using the workspace account for this task.
- Find the form containing https://example.com/help/refunds. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Use the button shown for the current state: Read & preview, Reading…. Creation and editing can show different labels; submit the form once.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| https://example.com/help/refunds | Required. Enter the complete address required by this field. For a callback or webhook, copy the URL shown by the running application instead of guessing its path. The form’s example is https://example.com/help/refunds. Replace it with your own value. Maximum 2000 characters. |
Create or update: Read & preview / Reading…
- Open /portal/inbox/knowledge-base on your application domain, using the workspace account for this task.
- Find the form containing File picker. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Use the button shown for the current state: Read & preview, Reading…. Creation and editing can show different labels; submit the form once.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| File picker | Required. Choose a file from your computer. Accepted types: .txt,.md,.csv,.html,.htm. Maximum 5120 KB. |
Use Open for review
- Open /portal/inbox/knowledge-base on your application domain, using the workspace account for this task.
- Select the intended record or item first and review its displayed values. There is no separate input form described for this control.
- Select Open for review. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
Create or update: Find matching sources / Checking…
- Open /portal/inbox/knowledge-base on your application domain, using the workspace account for this task.
- Find the form containing e.g. How can I change my subscription?. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Use the button shown for the current state: Find matching sources, Checking…. Creation and editing can show different labels; submit the form once.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| e.g. How can I change my subscription? | Required. Enter the e.g. how can i change my subscription? for this task, using the help or example shown by the form. The form’s example is e.g. How can I change my subscription?. Replace it with your own value. Maximum 1000 characters. |
Use Approve changes
- Open /portal/inbox/knowledge-base on your application domain, using the workspace account for this task.
- Select the intended record or item first and review its displayed values. There is no separate input form described for this control.
- Select Approve changes. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
Use Save as draft
- Open /portal/inbox/knowledge-base on your application domain, using the workspace account for this task.
- Find the form containing Title / e.g. How to change a subscription, Answer / guidance / Write the answer your team should give. Include useful steps, exceptions and links., Short summary / One sentence that makes this article easy to find.. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Save as draft. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| Title / e.g. How to change a subscription | Enter the title / e.g. how to change a subscription for this task, using the help or example shown by the form. The form’s example is e.g. How to change a subscription. Replace it with your own value. Maximum 255 characters. |
| Answer / guidance / Write the answer your team should give. Include useful steps, exceptions and links. | Enter the answer / guidance / write the answer your team should give. include useful steps, exceptions and links. for this task, using the help or example shown by the form. The form’s example is Write the answer your team should give. Include useful steps, exceptions and links.. Replace it with your own value. Maximum 60000 characters. |
| Short summary / One sentence that makes this article easy to find. | Enter the short summary / one sentence that makes this article easy to find. for this task, using the help or example shown by the form. The form’s example is One sentence that makes this article easy to find.. Replace it with your own value. Maximum 1000 characters. |
| Choose or add a category | Enter the choose or add a category for this task, using the help or example shown by the form. Maximum 120 characters. |
| Optional reference | Enter the optional reference for this task, using the help or example shown by the form. The form’s example is Optional reference. Replace it with your own value. Maximum 2000 characters. |
Fields and choices
Field descriptions appear beside each task above so that separate forms are not mixed together.
Check the result
- Stay in the same account/workspace and reopen the intended record or result screen.
- For saved settings, compare the displayed values with the choices you made. For filters and previews, check the current result scope.
- For queued or external work, inspect its status/history and provider result where applicable. A successful save does not by itself prove message delivery, publication, payment completion or provider approval.
Common problems
| Problem | What to check |
|---|---|
| The screen or action is missing | Check the correct workspace account, role, enabled app and plan. A hidden action is not fixed by typing an internal endpoint. |
| A field is rejected | Read its validation message, choose from the offered options and check the relevant format or limit. Do not substitute a database ID for a displayed choice. |
| A list is empty | Check the selected workspace, search text, date range and status filters. Clear one filter at a time before concluding that records are missing. |
| A request is still pending | Check its status/history before repeating it. For messages, publishing, imports and payments, a submitted request can finish later or fail separately. |
Technical reference
Role-scoped source references
Pinned commit: 68a5655db1bbe17c74fb211f0fe0ee4e63c8be88
- modules/Inbox/InboxKnowledgeBase/Livewire/KnowledgeBaseWorkspace.php
- modules/Inbox/InboxKnowledgeBase/resources/views/livewire/partials/knowledge-dialog-style.blade.php
- modules/Inbox/InboxKnowledgeBase/resources/views/livewire/partials/knowledge-style.blade.php
- modules/Inbox/InboxKnowledgeBase/resources/views/livewire/workspace.blade.php
Source-only route information
| Method | Source-default route |
|---|---|
| GET | /portal/inbox/knowledge-base |
Unmapped fields — not user instructions
These fields belong to this role’s source handler, but their screen labels were not confirmed.
| Source key | Handler |
|---|---|
| websiteUrl | modules/Inbox/InboxKnowledgeBase/Livewire/KnowledgeBaseWorkspace.php |
| importStatus | modules/Inbox/InboxKnowledgeBase/Livewire/KnowledgeBaseWorkspace.php |
| importFile | modules/Inbox/InboxKnowledgeBase/Livewire/KnowledgeBaseWorkspace.php |
| form.title | modules/Inbox/InboxKnowledgeBase/Livewire/KnowledgeBaseWorkspace.php |
| form.type | modules/Inbox/InboxKnowledgeBase/Livewire/KnowledgeBaseWorkspace.php |
| form.status | modules/Inbox/InboxKnowledgeBase/Livewire/KnowledgeBaseWorkspace.php |
| form.category | modules/Inbox/InboxKnowledgeBase/Livewire/KnowledgeBaseWorkspace.php |
| form.source_type | modules/Inbox/InboxKnowledgeBase/Livewire/KnowledgeBaseWorkspace.php |
| form.source_url | modules/Inbox/InboxKnowledgeBase/Livewire/KnowledgeBaseWorkspace.php |
| form.summary | modules/Inbox/InboxKnowledgeBase/Livewire/KnowledgeBaseWorkspace.php |
| form.content | modules/Inbox/InboxKnowledgeBase/Livewire/KnowledgeBaseWorkspace.php |
| channelInput | modules/Inbox/InboxKnowledgeBase/Livewire/KnowledgeBaseWorkspace.php |
| sourceConversationId | modules/Inbox/InboxKnowledgeBase/Livewire/KnowledgeBaseWorkspace.php |
| tagInput | modules/Inbox/InboxKnowledgeBase/Livewire/KnowledgeBaseWorkspace.php |
| testQuestion | modules/Inbox/InboxKnowledgeBase/Livewire/KnowledgeBaseWorkspace.php |