Laravel Packages

Laravel Envoyer API Package

Published
Laravel Envoyer API Package image

Laravel Envoyer SDK is a community package by Steve McDougall to work with the Laravel Envoyer API. Laravel released an API for Envoyer on November 4th, which allows users to interact with Envoyer via a REST API.

If you want to have a play with this API, you can even use this handy SDK I whipped together for you #php #phpc #laravel https://t.co/mFiTm2Qrw6 https://t.co/PBx7EYSZd5

— Steve McDougall (@JustSteveKing) November 4, 2020

Here’s how you can get an instance of the API client:

use JustSteveKing\Laravel\Envoyer\SDK\Envoyer;
 
$envoyer = Envoyer::illuminate(
API_TOKEN_HERE,
'https://envoyer.io/' // this is optional as is the default
);

Once you have an instance of the client, you can perform calls for the various Envoyer API endpoints:

// Get all projects
$envoyer->projects->all();
 
// Create a project
$envoyer->projects->save([
'name' => 'SDK test',
'provider' => 'github', // bitbucket, github, gitlab, gitlab-self
'type' => 'laravel-5', // laravel-5. laravel-4, other
'repository' => 'laravel/laravel',
'branch' => 'master'
]);
 
// Find a project by ID
$envoyer->projects->find('id-of-project');
 
// Modify a project
$envoyer->projects->modify('id-of-project', [
'name' => 'Project name update through SDK',
]);

You can perform the following types of actions with this SDK:

  • Manage projects
  • Manage servers
  • Manage project environments
  • Manage action hooks
  • Manage deployments
  • Manage collaborators
  • Manage notifications

Learn More

You can learn more about this package, get full installation instructions, and view the source code on GitHub at JustSteveKing/laravel-envoyer-sdk. Laravel released API Documentation for the new Envoyer API that you can reference for details on getting started with the API.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Sponsored

laravelcloud logo
Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Visit Laravel Cloud

The latest

View all →
CPX: The Composer Package Executor for PHP image

CPX: The Composer Package Executor for PHP

Read article
Laravel AI SDK Adds Human-in-the-Loop Tool Approval image

Laravel AI SDK Adds Human-in-the-Loop Tool Approval

Read article
Pest 5 Released With Test Impact Analysis, Agent Verification, and Evals image

Pest 5 Released With Test Impact Analysis, Agent Verification, and Evals

Read article
Queue-SQL: Run Mass Deletes and Updates Across Parallel Queue Jobs image

Queue-SQL: Run Mass Deletes and Updates Across Parallel Queue Jobs

Read article
Blade Formatting in Laravel Pint image

Blade Formatting in Laravel Pint

Read article
Inertia DevTools Is Now on the Chrome Web Store image

Inertia DevTools Is Now on the Chrome Web Store

Read article