PHPackages                             habeebdev/twilio-webhook-tester - 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. [CLI & Console](/categories/cli)
4. /
5. habeebdev/twilio-webhook-tester

ActiveLibrary[CLI & Console](/categories/cli)

habeebdev/twilio-webhook-tester
===============================

PHP wrapper for Twilio CLI webhook plugin - Test Twilio SMS webhooks locally using the Twilio CLI webhook plugin

v1.0.0(5mo ago)011MITPHPPHP ^8.0

Since Jan 15Pushed 5mo agoCompare

[ Source](https://github.com/habeebdev/twilio-webhook-tester)[ Packagist](https://packagist.org/packages/habeebdev/twilio-webhook-tester)[ RSS](/packages/habeebdev-twilio-webhook-tester/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (3)Versions (2)Used By (0)

Twilio Webhook Tester
=====================

[](#twilio-webhook-tester)

PHP wrapper for Twilio CLI webhook plugin - Test Twilio SMS webhooks locally using the Twilio CLI webhook plugin.

Features
--------

[](#features)

- 🚀 Test SMS webhooks locally
- 🔒 Support for secured webhooks (with signature validation)
- 🔓 Support for unsecured webhooks
- 📝 Custom data parameters
- 🌐 GET and POST HTTP methods
- ⚡ Fast and lightweight
- 🔌 Uses official Twilio CLI webhook plugin
- 🎲 Automatic generation of realistic test data using Faker

Prerequisites
-------------

[](#prerequisites)

This wrapper requires the Twilio CLI and webhook plugin to be installed:

1. **Install Twilio CLI:**

    ```
    # macOS/Linux
    brew tap twilio/brew && brew install twilio

    # Or using npm
    npm install -g twilio-cli

    # See: https://www.twilio.com/docs/twilio-cli/quickstart
    ```
2. **Install Webhook Plugin:**

    ```
    twilio plugins:install @twilio-labs/plugin-webhook
    ```
3. **Verify Installation:**

    ```
    twilio webhook:invoke --help
    ```

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

[](#installation)

```
composer require habeebdev/twilio-webhook-tester
```

Usage
-----

[](#usage)

### Basic Usage

[](#basic-usage)

```
# Test an SMS webhook
vendor/bin/twilio-webhook https://your-webhook-url.com/webhook

# Or using environment variable
# Set in .env: WEBHOOK_URL=https://your-webhook-url.com/webhook
vendor/bin/twilio-webhook
```

### With Custom Data

[](#with-custom-data)

```
# Add custom parameters
vendor/bin/twilio-webhook https://your-webhook-url.com/webhook \
  -d Body="Hello, how are you?" \
  -d From=+15551234567 \
  -d To=+15559876543
```

### HTTP Methods

[](#http-methods)

```
# Use GET method
vendor/bin/twilio-webhook https://your-webhook-url.com/webhook --method GET

# Use POST method (default)
vendor/bin/twilio-webhook https://your-webhook-url.com/webhook --method POST
```

### Secured Webhooks

[](#secured-webhooks)

For webhooks that validate the `X-Twilio-Signature` header:

**Option 1: Using .env file (recommended)**

Create a `.env` file in your project root:

```
# .env file
TWILIO_ACCOUNT_SID=ACxxxxx
TWILIO_AUTH_TOKEN=your_auth_token_here
```

Or with API Key/Secret:

```
# .env file
TWILIO_ACCOUNT_SID=ACxxxxx
TWILIO_API_KEY=SKxxxxx
TWILIO_API_SECRET=your_api_secret
```

Then run:

```
vendor/bin/twilio-webhook https://your-webhook-url.com/webhook
```

**Option 2: Using command-line arguments**

```
# Using Auth Token
vendor/bin/twilio-webhook https://your-webhook-url.com/webhook \
  --account-sid ACxxxxx \
  --auth-token your_auth_token_here

# Using API Key/Secret
vendor/bin/twilio-webhook https://your-webhook-url.com/webhook \
  --account-sid ACxxxxx \
  --api-key SKxxxxx \
  --api-secret your_api_secret
```

### Unsecured Webhooks

[](#unsecured-webhooks)

For webhooks that don't validate signatures:

```
vendor/bin/twilio-webhook https://your-webhook-url.com/webhook --no-signature
```

Command Options
---------------

[](#command-options)

```
Usage:
  twilio-webhook [WEBHOOK_URL] [OPTIONS]

Arguments:
  WEBHOOK_URL              The webhook URL to invoke (optional if WEBHOOK_URL is set in .env)

Options:
  -a, --auth-token TOKEN   Twilio Auth Token (or set TWILIO_AUTH_TOKEN env var)
  --account-sid SID        Twilio Account SID (or set TWILIO_ACCOUNT_SID env var)
  --api-key KEY            Twilio API Key (or set TWILIO_API_KEY env var)
  --api-secret SECRET      Twilio API Secret (or set TWILIO_API_SECRET env var)
  -X, --method METHOD      HTTP method (GET or POST, default: POST)
  -d, --data-urlencode     Add data parameter (format: KEY=VALUE, can be used multiple times)
  --no-signature           Skip signature generation (for unsecured webhooks)

```

Automatic Data Generation
-------------------------

[](#automatic-data-generation)

The tool automatically generates realistic test data using [Faker](https://fakerphp.github.io/) when parameters are not provided:

### Automatically Generated Fields

[](#automatically-generated-fields)

- **MessageSid**: Unique SMS message SID (format: `SM...`)
- **SmsMessageSid**: Same as MessageSid
- **SmsSid**: Same as MessageSid
- **AccountSid**: Random account SID (format: `AC...`)
- **MessagingServiceSid**: From `TWILIO_MESSAGING_SERVICE_SID` env var (if set), otherwise not included
- **From**: Random US phone number (E.164 format) or from `FROM_PHONE_NUMBER` env var
- **To**: Random US phone number (E.164 format) or from `TO_PHONE_NUMBER` env var
- **Body**: Random English message (20-80 characters)
- **FromCountry/ToCountry**: "US"
- **FromState/ToState**: Random US state abbreviation
- **FromCity/ToCity**: Random US city name
- **FromZip/ToZip**: Random US zip code
- **NumMedia**: "0"
- **SmsStatus**: Random from \['received', 'sent', 'delivered'\]

### Overriding Default Values

[](#overriding-default-values)

You can override any automatically generated value using the `-d` option:

```
vendor/bin/twilio-webhook https://your-webhook-url.com/webhook \
  -d Body="Custom message" \
  -d From=+15551234567 \
  -d MessageSid=SM1234567890abcdef
```

Examples
--------

[](#examples)

### Example 1: Basic SMS Webhook

[](#example-1-basic-sms-webhook)

```
vendor/bin/twilio-webhook https://hello-messaging-1111-xxxxxx.twil.io/hello-messaging
```

Expected output (TwiML):

```

  Hello World

```

### Example 2: Custom SMS Parameters

[](#example-2-custom-sms-parameters)

```
vendor/bin/twilio-webhook https://your-webhook-url.com/webhook \
  -d Body="Hi, how are you doing?" \
  -d From=+15551234567 \
  -d To=+15559876543
```

### Example 3: Testing Protected Webhook

[](#example-3-testing-protected-webhook)

```
# Using .env file (recommended)
# Add to .env: TWILIO_ACCOUNT_SID=ACxxxxx and TWILIO_AUTH_TOKEN=your_token
vendor/bin/twilio-webhook https://protected-webhook.twil.io/function

# Or using command-line arguments
vendor/bin/twilio-webhook https://protected-webhook.twil.io/function \
  --account-sid ACxxxxx \
  --auth-token your_auth_token_here
```

Environment Variables
---------------------

[](#environment-variables)

**Important**: The Twilio CLI requires authentication. You must set one of the following combinations in your `.env` file:

### Using .env File (Recommended)

[](#using-env-file-recommended)

Create a `.env` file in your project root:

**Option 1: API Key/Secret (Recommended)**

```
# .env file
TWILIO_ACCOUNT_SID=ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
TWILIO_API_KEY=SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
TWILIO_API_SECRET=your_api_secret_here
```

**Option 2: Auth Token**

```
# .env file
TWILIO_ACCOUNT_SID=ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
TWILIO_AUTH_TOKEN=your_auth_token_here
```

**Webhook URL (Optional)**

```
# .env file
WEBHOOK_URL=https://your-webhook-url.com/webhook  # Default webhook URL
```

**Phone Number Defaults (Optional)**

```
# .env file
FROM_PHONE_NUMBER=+15551234567  # Default From number
TO_PHONE_NUMBER=+15559876543    # Default To number
```

**Messaging Service SID (Optional)**

```
# .env file
TWILIO_MESSAGING_SERVICE_SID=MGxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx  # Messaging Service SID
```

**Quick Setup:**

```
# Copy the example file
cp .env.example .env

# Edit .env with your actual credentials
# The tool automatically loads .env - no need to source it!
vendor/bin/twilio-webhook https://example.com/webhook
```

**Note**:

- `TWILIO_ACCOUNT_SID` is required for both authentication options
- For webhook signature validation, you need either `TWILIO_AUTH_TOKEN` OR (`TWILIO_API_KEY` + `TWILIO_API_SECRET`)
- `WEBHOOK_URL` can be set in `.env` file to avoid passing URL as argument each time
- Command-line arguments take precedence over `.env` file values
- If `FROM_PHONE_NUMBER` or `TO_PHONE_NUMBER` are not set, random phone numbers will be generated
- `TWILIO_MESSAGING_SERVICE_SID` is optional - if not set, it will not be included in the webhook data
- The `.env` file is gitignored for security. Never commit your actual credentials to version control.

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

[](#requirements)

- PHP ^8.0
- Twilio CLI installed and in PATH
- Twilio CLI webhook plugin installed (`@twilio-labs/plugin-webhook`)
- Node.js (required by Twilio CLI)

License
-------

[](#license)

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

Related Resources
-----------------

[](#related-resources)

- [Twilio Webhook Plugin Documentation](https://www.twilio.com/en-us/blog/validate-webhooks-with-new-webhook-plugin-for-twilio-cli)
- [Twilio Webhook Security](https://www.twilio.com/docs/usage/webhooks/webhooks-security)
- [Twilio CLI](https://www.twilio.com/docs/twilio-cli/quickstart)

Support
-------

[](#support)

For issues and questions:

- Open an issue on GitHub
- Check the [Twilio Documentation](https://www.twilio.com/docs)

Acknowledgments
---------------

[](#acknowledgments)

This project is inspired by the [Twilio CLI Webhook Plugin](https://github.com/twilio-labs/plugin-webhook).

###  Health Score

32

—

LowBetter than 69% of packages

Maintenance70

Regular maintenance activity

Popularity5

Limited adoption so far

Community6

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

169d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/6295940?v=4)[Habeeb Rahman](/maintainers/habeebdev)[@habeebdev](https://github.com/habeebdev)

---

Top Contributors

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

---

Tags

clismstwiliowebhookwebhook-testing

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/habeebdev-twilio-webhook-tester/health.svg)

```
[![Health](https://phpackages.com/badges/habeebdev-twilio-webhook-tester/health.svg)](https://phpackages.com/packages/habeebdev-twilio-webhook-tester)
```

###  Alternatives

[n98/magerun2

Tools for managing Magento projects and installations

930245.4k6](/packages/n98-magerun2)[tempest/framework

The PHP framework that gets out of your way.

2.2k34.4k15](/packages/tempest-framework)[n98/magerun

Tools for managing Magento projects and installations

1.4k266.9k7](/packages/n98-magerun)[lion/bundle

Lion-framework configuration and initialization package

122.3k4](/packages/lion-bundle)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

245.2k](/packages/aedart-athenaeum)[php-school/php-workshop

PHP Workshop Framework

466.8k6](/packages/php-school-php-workshop)

PHPackages © 2026

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