PHPackages                             isaadsalman/headless-refresh - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. isaadsalman/headless-refresh

ActiveStatamic-addon

isaadsalman/headless-refresh
============================

Statamic addon for triggering headless updates.

1.0.0(1y ago)21241PHP

Since Jul 3Pushed 1y ago1 watchersCompare

[ Source](https://github.com/iSaadSalman/headless-refresh)[ Packagist](https://packagist.org/packages/isaadsalman/headless-refresh)[ RSS](/packages/isaadsalman-headless-refresh/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)DependenciesVersions (2)Used By (0)

Headless Refresh - Statamic Addon
=================================

[](#headless-refresh---statamic-addon)

The Statamic Headless Refresh addon enhances your Statamic experience by seamlessly integrating headless CMS capabilities. It provides a convenient dashboard widget that allows you to trigger updates to your decoupled website directly from the Statamic backend. The plugin also supports automated URL triggers tied to specific events, such as when an entry is saved, ensuring your headless site is always up-to-date. Events are also customizable.

Key Features
------------

[](#key-features)

1. **Dashboard Widget:** Optionally add a widget to your Statamic dashboard for easy manual refreshes.
2. **Event-Driven Triggers:** Automate the refresh process by tying URL triggers to events like entry saves.

Effortlessly manage and synchronize your headless CMS updates with Statamic Headless Refresh.

Installation
------------

[](#installation)

To install the Headless Refresh addon, follow these steps:

1. Install the addon via Composer:

    ```
    composer require isaadsalman/headless-refresh
    ```
2. Publish the addon assets and configuration:

    ```
    php artisan vendor:publish --tag=headless-refresh-config
    ```
3. Update the configuration file `config/statamic/headless-refresh.php` as needed (see the Configuration section below).

Configuration
-------------

[](#configuration)

The configuration for the Headless Refresh addon is found in `config/statamic/headless-refresh.php`. Modify the following options as required:

```
return [
    'event_trigger' => env('HEADLESS_REFRESH_EVENT_TRIGGER', false),
    'trigger_link' => env('HEADLESS_REFRESH_TRIGGER_LINK', null),
    'deployment_message' => env('HEADLESS_REFRESH_DEPLOYMENT_MESSAGE', "Deployed"),
    'events' => [
        Statamic\Events\EntrySaved::class,
        Statamic\Events\EntryDeleted::class,
        Statamic\Events\NavSaved::class,
        Statamic\Events\NavDeleted::class,
        Statamic\Events\NavTreeSaved::class,
        Statamic\Events\NavTreeDeleted::class,
        Statamic\Events\TaxonomySaved::class,
        Statamic\Events\TaxonomyDeleted::class,
    ],
    'live_updates_notice_title' => 'Live Updates Notice',
    'live_updates_notice_text' => 'Please note that your updates will be visible online within 5 minutes from when you save an entry. If you require immediate visibility, simply click the button below.',
    'live_updates_notice_button' => 'Refresh Now'
];
```

### Configuration Options:

[](#configuration-options)

- `event_trigger`: Set to `true` to enable the event-based trigger.
- `trigger_link`: Define the URL or link that triggers the headless refresh.
- `deployment_message`: Customize the message displayed upon successful deployment.
- `events`: Specify the events that should trigger the headless refresh.
- `live_updates_notice_title`: Widget title
- `live_updates_notice_text`: Widget description text
- `live_updates_notice_button`: Widget button text.

Usage
-----

[](#usage)

### Event-Based Trigger (Optional)

[](#event-based-trigger-optional)

To enable the event-based trigger, set the `event_trigger` to `true` in the configuration file. This will trigger the headless refresh based on specified events.

### Dashboard Widget

[](#dashboard-widget)

You can add the Headless Refresh widget to your dashboard by including it using its handle `'headless-refresh'`.

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance33

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity40

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

677d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/06ff15006b55b83195c40f167779cbefa7bc296feef367ee3bdcb1669121a539?d=identicon)[siner55](/maintainers/siner55)

---

Top Contributors

[![iSaadSalman](https://avatars.githubusercontent.com/u/736170?v=4)](https://github.com/iSaadSalman "iSaadSalman (4 commits)")

### Embed Badge

![Health badge](/badges/isaadsalman-headless-refresh/health.svg)

```
[![Health](https://phpackages.com/badges/isaadsalman-headless-refresh/health.svg)](https://phpackages.com/packages/isaadsalman-headless-refresh)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)