All guides
User

Channels

Connect or manage the provider accounts used by this feature.

Step-by-step guide

Before you start

Use the account and workspace that own the records. This page does not include administrator configuration forms.

Open this feature

Open /portal/channels on your application domain, or use the matching item in the application menu.

Steps

Save channel

  1. Open /portal/channels on your own application domain.
  2. Complete these fields in that form: Display name, Username / handle, External ID, Category, Connection type, Profile URL, Avatar URL, Reconnect URL, Access token, Refresh token, Scopes, Auth payload JSON, Metadata JSON, Internal notes. Their choices and limits are listed below.
  3. Select Save channel. The exact label can change between creating and editing a record.
  4. If validation fails, correct the named field and submit again. After success, reopen the same record and compare the saved values.
Field shown in the formWhat to enterExample / note
Display nameRequired. No more than 255 characters.Test record (use a unique value where required).
Username / handleOptional, unless this form asks for it. No more than 255 characters.Use the value required by the task; no example is assumed.
External IDOptional, unless this form asks for it. No more than 255 characters.Use the value required by the task; no example is assumed.
CategoryOptional, unless this form asks for it.Use the value required by the task; no example is assumed.
Connection typeRequired.Use the value required by the task; no example is assumed.
Profile URLOptional, unless this form asks for it. Enter a complete URL, including https:// where appropriate. No more than 500 characters.https://example.test/demo (replace with your own test destination).
Avatar URLOptional, unless this form asks for it. Enter a complete URL, including https:// where appropriate. No more than 500 characters.https://example.test/demo (replace with your own test destination).
Reconnect URLOptional, unless this form asks for it. Enter a complete URL, including https:// where appropriate. No more than 500 characters.https://example.test/demo (replace with your own test destination).
Access tokenOptional, unless this form asks for it. No more than 5000 characters. Enter the real value privately; do not put it in a screenshot or support message.Use the value appropriate to your test account; no preset is supplied.
Refresh tokenOptional, unless this form asks for it. No more than 5000 characters. Enter the real value privately; do not put it in a screenshot or support message.Use the value appropriate to your test account; no preset is supplied.
ScopesOptional, unless this form asks for it. No more than 2000 characters.Use the value required by the task; no example is assumed.
Auth payload JSONOptional, unless this form asks for it.Use the value required by the task; no example is assumed.
Metadata JSONOptional, unless this form asks for it.Use the value required by the task; no example is assumed.
Internal notesOptional, unless this form asks for it. No more than 4000 characters.Use the value required by the task; no example is assumed.

Fields shown in the interface

Only fields traced to this role’s handler and its own view are listed. The application can show separate create/edit forms; do not fill every row on one screen.

Form 1 — fields shown in the interface
FieldWhat to enter or choose
Display nameRequired. No more than 255 characters.
Username / handleOptional, unless this form asks for it. No more than 255 characters.
External IDOptional, unless this form asks for it. No more than 255 characters.
CategoryOptional, unless this form asks for it.
Connection typeRequired.
Profile URLOptional, unless this form asks for it. Enter a complete URL, including https:// where appropriate. No more than 500 characters.
Avatar URLOptional, unless this form asks for it. Enter a complete URL, including https:// where appropriate. No more than 500 characters.
Reconnect URLOptional, unless this form asks for it. Enter a complete URL, including https:// where appropriate. No more than 500 characters.
Access tokenOptional, unless this form asks for it. No more than 5000 characters. Enter the real value privately; do not put it in a screenshot or support message.
Refresh tokenOptional, unless this form asks for it. No more than 5000 characters. Enter the real value privately; do not put it in a screenshot or support message.
ScopesOptional, unless this form asks for it. No more than 2000 characters.
Auth payload JSONOptional, unless this form asks for it.
Metadata JSONOptional, unless this form asks for it.
Internal notesOptional, unless this form asks for it. No more than 4000 characters.

Check the result

After a source-checked procedure, verify the same record in the same workspace. Check saved values, visible state and access with the intended test account. An external payment/message/provider action needs its own result check.

Problems and validation

ProblemNext step
A field rejects the valueCheck its named error, the form’s visible choices and the relevant limit. Do not substitute internal numeric codes for the displayed options.
The control is missingCheck role, plan, enabled app and current record state. Do not grant administrator access merely to complete a User task.
The saved result is unexpectedReopen the same record and verify its owner/workspace before repeating the action.

Technical reference

Role-scoped source references

Pinned commit: 1d0944d30f606782c9abf5b878224cdd3cd09b99

Source-only route information
MethodSource-default route
LIVEWIRE/portal/channels
Unmapped fields — not user instructions

These fields belong to this role’s source handler, but their screen labels were not confirmed.

Source keyHandler
accountForm.is_activemodules/AppChannels/Livewire/PortalDashboard.php