PHPackages                             nigel/freescout-webhook-parser - 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. [Parsing & Serialization](/categories/parsing)
4. /
5. nigel/freescout-webhook-parser

ActiveLibrary[Parsing & Serialization](/categories/parsing)

nigel/freescout-webhook-parser
==============================

A PHP library for parsing FreeScout webhook data with HTML cleaning capabilities

1.0.3(1y ago)28MITPHPPHP ^8.0

Since Apr 14Pushed 1y ago1 watchersCompare

[ Source](https://github.com/xulerxyz/freescout_webhook_parser)[ Packagist](https://packagist.org/packages/nigel/freescout-webhook-parser)[ RSS](/packages/nigel-freescout-webhook-parser/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (1)Versions (4)Used By (0)

FreeScout Webhook Parser
========================

[](#freescout-webhook-parser)

A PHP library for parsing FreeScout webhook data with HTML cleaning capabilities.

Features
--------

[](#features)

- Parse FreeScout webhook data
- Clean HTML content using HtmlCleaner
- Support for both basic and extended data fields
- Easy to use interface
- Type-safe data access

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

[](#installation)

```
composer require nigel/freescout-webhook-parser
```

Usage
-----

[](#usage)

### Basic Usage

[](#basic-usage)

```
use Nigel\FreescoutWebhookParser\FreeScoutWebhookParser;

// Get webhook data
$rawData = file_get_contents('php://input');

// Create parser instance
$parser = new FreeScoutWebhookParser($rawData);

// Parse the data
$result = $parser->parse();

// Get basic fields
$basicFields = $result->getBasicFields();

// Get all fields
$allFields = $result->getAllFields();
```

### Basic Fields

[](#basic-fields)

The `getBasicFields()` method returns the most commonly used fields:

```
[
    'subject' => string,
    'body' => string,
    'from' => string,
    'to' => string,
    'date' => string,
    'type' => string,
    'status' => string,
    'customer' => [
        'name' => string,
        'email' => string
    ],
    'conversation_id' => string,
    'thread_id' => string
]
```

### All Fields

[](#all-fields)

The `getAllFields()` method returns all available fields:

```
[
    'subject' => string,
    'body' => string,
    'from' => string,
    'to' => string,
    'cc' => string,
    'bcc' => string,
    'date' => string,
    'message_id' => string,
    'in_reply_to' => string,
    'references' => string,
    'attachments' => array,
    'headers' => array,
    'custom_fields' => array,
    'conversation_id' => string,
    'thread_id' => string,
    'type' => string,
    'status' => string,
    'customer' => [
        'id' => string,
        'name' => string,
        'email' => string
    ],
    'mailbox' => [
        'id' => string,
        'name' => string
    ],
    'user' => [
        'id' => string,
        'name' => string,
        'email' => string
    ],
    'dates' => [
        'created_at' => string,
        'updated_at' => string,
        'deleted_at' => string
    ],
    'tags' => array,
    'custom_data' => array,
    'meta' => array
]
```

Requirements
------------

[](#requirements)

- PHP 8.0 or higher
- Composer

License
-------

[](#license)

This project is licensed under the MIT License - see the LICENSE file for details.

###  Health Score

29

—

LowBetter than 60% of packages

Maintenance49

Moderate activity, may be stable

Popularity7

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity44

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

Every ~11 days

Total

3

Last Release

369d ago

PHP version history (2 changes)1.0.0PHP ^8.1

1.0.2PHP ^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/b438a75edf013d1646299b1bb17fa137c79665123a4cee336f1944c5481a7efb?d=identicon)[iamnigelzw](/maintainers/iamnigelzw)

---

Top Contributors

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

---

Tags

freescoutparserphpwebhook

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/nigel-freescout-webhook-parser/health.svg)

```
[![Health](https://phpackages.com/badges/nigel-freescout-webhook-parser/health.svg)](https://phpackages.com/packages/nigel-freescout-webhook-parser)
```

###  Alternatives

[mtdowling/jmespath.php

Declaratively specify how to extract elements from a JSON document

2.0k472.8M135](/packages/mtdowling-jmespathphp)[opis/closure

A library that can be used to serialize closures (anonymous functions) and arbitrary data.

2.6k230.0M284](/packages/opis-closure)[masterminds/html5

An HTML5 parser and serializer.

1.8k242.8M226](/packages/masterminds-html5)[sabberworm/php-css-parser

Parser for CSS Files written in PHP

1.8k191.2M63](/packages/sabberworm-php-css-parser)[michelf/php-markdown

PHP Markdown

3.5k52.4M344](/packages/michelf-php-markdown)[jms/metadata

Class/method/property metadata management in PHP

1.8k152.8M88](/packages/jms-metadata)

PHPackages © 2026

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