User
Web Push API
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/web-push/developer on your site.
Steps
Choose a task
Use Create key
- Open /portal/web-push/developer on your application domain, using the workspace account for this task.
- Find the form containing Key name. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Create key. 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 |
|---|---|
| Key name | Required. Enter the key name for this task, using the help or example shown by the form. The form’s example is Storefront production. Replace it with your own value. Maximum 120 characters. |
Use Save
- Open /portal/web-push/developer on your application domain, using the workspace account for this task.
- Find the form containing Default title, Default message, Quiet hours start. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Save. 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 |
|---|---|
| Default title | Optional unless the current form requests it. Enter the default title for this task, using the help or example shown by the form. Maximum 120 characters. |
| Default message | Optional unless the current form requests it. Enter the default message for this task, using the help or example shown by the form. Maximum 500 characters. |
| Quiet hours start | Optional unless the current form requests it. Enter the quiet hours start for this task, using the help or example shown by the form. |
| Quiet hours end | Optional unless the current form requests it. Enter the quiet hours end for this task, using the help or example shown by the form. |
| Delivery timezone | Required. Enter the delivery timezone for this task, using the help or example shown by the form. |
Use Refresh
- Open /portal/web-push/developer 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 Refresh. 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 Refresh
- Open /portal/web-push/developer on your application domain, using the workspace account for this task.
- Find the form containing Default title, Default message, Quiet hours start. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Refresh. 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 |
|---|---|
| Default title | Enter the default title for this task, using the help or example shown by the form. Maximum 120 characters. |
| Default message | Enter the default message for this task, using the help or example shown by the form. Maximum 500 characters. |
| Quiet hours start | Enter the quiet hours start for this task, using the help or example shown by the form. |
| Quiet hours end | Enter the quiet hours end for this task, using the help or example shown by the form. |
| Delivery timezone | Enter the delivery timezone for this task, using the help or example shown by the form. |
Use Add webhook
- Open /portal/web-push/developer on your application domain, using the workspace account for this task.
- Find the form containing Name, Endpoint URL. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Add webhook. 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 |
|---|---|
| Name | Required. Enter the name for this task, using the help or example shown by the form. Maximum 120 characters. |
| Endpoint URL | 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. Maximum 2048 characters. |
Use Create
- Open /portal/web-push/developer on your application domain, using the workspace account for this task.
- Find the form containing Key name. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Create. 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 |
|---|---|
| Key name | Required. Enter the key name for this task, using the help or example shown by the form. Maximum 120 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
Source-only route information
| Method | Source-default route |
|---|---|
| LIVEWIRE | /portal/web-push/developer |
| POST | /api/v1/web-push/notifications |
| POST | /api/v1/web-push/events |
Unmapped fields — not user instructions
These fields belong to this role’s source handler, but their screen labels were not confirmed.
| Source key | Handler |
|---|---|
| site_id | modules/WebPush/WebPushApi/Http/Controllers/AutomationEventController.php |
| subscription_id | modules/WebPush/WebPushApi/Http/Controllers/AutomationEventController.php |
| external_id | modules/WebPush/WebPushApi/Http/Controllers/AutomationEventController.php |
| event | modules/WebPush/WebPushApi/Http/Controllers/AutomationEventController.php |
| event_key | modules/WebPush/WebPushApi/Http/Controllers/AutomationEventController.php |
| attributes | modules/WebPush/WebPushApi/Http/Controllers/AutomationEventController.php |
| occurred_at | modules/WebPush/WebPushApi/Http/Controllers/AutomationEventController.php |