Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.exowizz.com/llms.txt

Use this file to discover all available pages before exploring further.

This guide gives you one fast win: create one Resource and see it live in the Exo API.

​
Before you start

  • PHP 8.3+
  • Laravel 12 or 13

​
2-3 minute setup

1

Install Exo and run migrations

composer require exowizz/exo
php artisan exo:install
2

Create an API user and copy the token

php artisan exo:user
Exo shows the token once. Copy it before closing your terminal.
exo:install updates your configured local User model for Passport tokens when possible. If it cannot edit the file safely, it prints the exact User model change to make before running exo:user.
3

Generate your first Resource

php artisan exo:resource ContactResource --model="App\Models\Contact" --triggers=on_create,on_update,on_delete
This creates app/Exo/Resources/ContactResource.php.
4

Confirm the Resource is live

curl -H "Authorization: Bearer YOUR_TOKEN" \
     http://your-app.test/exo-api/resources
Expected response:
{
  "data": [
    {
      "name": "contact",
      "model": "App\\Models\\Contact",
      "triggers": ["on_create", "on_update", "on_delete"]
    }
  ]
}

​
What you just unlocked

  • A Resource definition for your Contact model
  • Exo API metadata at GET /exo-api/resources
  • Trigger wiring for on_create, on_update, and on_delete

​
Next step

Build your first full Resource

Add clean transformers, test endpoints, and understand each required Resource method.

Connect triggers to webhooks

Learn how Resource triggers become webhook deliveries.