Developer API
Read or manage the records shown by this feature.
Before you start
Use the account and workspace that own the records. This page does not include administrator configuration forms.
Open /portal/developer on your application domain, or use the matching item in the application menu.
Steps
Generate key
- Open /portal/developer on your own application domain.
- Complete these fields in that form: Key name. Their choices and limits are listed below.
- Select Generate key. The exact label can change between creating and editing a record.
- 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 form | What to enter | Example / note |
|---|---|---|
| Key name | Required. No more than 120 characters. | Use the value required by the task; no example is assumed. |
Save webhook
- Open /portal/developer on your own application domain.
- Complete these fields in that form: Webhook name, Destination URL. Their choices and limits are listed below.
- Select Save webhook. The exact label can change between creating and editing a record.
- 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 form | What to enter | Example / note |
|---|---|---|
| Webhook name | Required. No more than 120 characters. | Use the value required by the task; no example is assumed. |
| Destination URL | Required. No more than 1000. | 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
| Field | What to enter or choose |
|---|---|
| Key name | Required. No more than 120 characters. |
| Webhook name | Required. No more than 120 characters. |
| Destination URL | Required. No more than 1000. |
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
| Problem | Next step |
|---|---|
| A field rejects the value | Check 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 missing | Check role, plan, enabled app and current record state. Do not grant administrator access merely to complete a User task. |
| The saved result is unexpected | Reopen the same record and verify its owner/workspace before repeating the action. |
Technical reference
Role-scoped source references
Pinned commit: 1d0944d30f606782c9abf5b878224cdd3cd09b99
- modules/AppDeveloperApi/Livewire/DeveloperApiIndex.php
- modules/AppDeveloperApi/resources/views/livewire/index.blade.php
- modules/AppDeveloperApi/resources/views/livewire/partials/post-options.blade.php
- modules/AppDeveloperApi/resources/views/livewire/partials/quick-start.blade.php
- modules/AppDeveloperApi/resources/views/livewire/partials/refresh-style.blade.php
- modules/AppDeveloperApi/resources/views/livewire/partials/workspace-style.blade.php
Source-only route information
| Method | Source-default route |
|---|---|
| LIVEWIRE | /portal/developer |
Unmapped fields — not user instructions
These fields belong to this role’s source handler, but their screen labels were not confirmed.
| Source key | Handler |
|---|---|
| keyPermissions | modules/AppDeveloperApi/Livewire/DeveloperApiIndex.php |
| keyPermissions.* | modules/AppDeveloperApi/Livewire/DeveloperApiIndex.php |
| selectedEvents | modules/AppDeveloperApi/Livewire/DeveloperApiIndex.php |
| selectedEvents.* | modules/AppDeveloperApi/Livewire/DeveloperApiIndex.php |