README

PHP client for the Laravel Envoyer REST API.

Maintained replacement for community SDKs that lag behind the official API (including heartbeats).

Requirements

• PHP 8.2+
• ext-json

Installation

composer require nomadicsoft/envoyer-php

Create an API token in Envoyer under User Settings → API Tokens.

Usage

use Nomadicsoft\Envoyer\Envoyer;

$envoyer = Envoyer::make($apiToken);

// Projects
$envoyer->projects()->all();
$envoyer->projects()->find($projectId);

// Environment (.env in Envoyer — canonical source, not the server file)
$envoyer->environments()->on($projectId)->get($environmentKey);
$envoyer->environments()->on($projectId)->update($environmentKey, $contents, $serverIds);
$envoyer->environments()->on($projectId)->servers();

// Deployments
$envoyer->deployments()->on($projectId)->all();
$envoyer->deployments()->on($projectId)->deploy(['from' => 'branch', 'branch' => 'main']);

// Servers, hooks, heartbeats, collaborators, notifications, actions
$envoyer->servers()->on($projectId)->all();
$envoyer->hooks()->on($projectId)->all();
$envoyer->heartbeats()->on($projectId)->all();
$envoyer->actions()->all();

Errors

Non-success HTTP responses throw Nomadicsoft\Envoyer\Exceptions\EnvoyerException with getStatusCode() and getResponseBody().

License

MIT