PHPackages sleepfinance/laravel-restcord - 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. [API Development](/categories/api) 4. / 5. sleepfinance/laravel-restcord ActiveLibrary[API Development](/categories/api) sleepfinance/laravel-restcord ============================= 1.0.9(3y ago)0230MITPHPPHP ^7.3|^8.0|^8.1 Since Jan 19Pushed 3y agoCompare [ Source](https://github.com/sleepfinance/laravel-restcord)[ Packagist](https://packagist.org/packages/sleepfinance/laravel-restcord)[ Docs](https://github.com/sleepfinance/laravel-restcord)[ RSS](/packages/sleepfinance-laravel-restcord/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependencies (11)Versions (7)Used By (0) About sleep finance =================== [](#about-sleep-finance) [Sleep.finance](https://sleep.finance) is an innovative cryptocurrency launchpad designed to help new crypto projects get off the ground with ease. The platform offers a comprehensive suite of tools and features to help manage projects from start to finish, including fundraising, marketing, and community engagement. [Sleep.finance](https://sleep.finance) provide a safe, secure, and user-friendly platform for your project's launch. Whether you're a seasoned crypto entrepreneur or just starting out, [Sleep.finance](https://sleep.finance) is the perfect launchpad for your next big idea. Join us today and take your crypto project to new heights! laravel-restcord (Laravel 8) ============================ [](#laravel-restcord-laravel-8) The repository is a fork of [more-cores/laravel-restcord](https://gitlab.com/more-cores/laravel-restcord), it was updated to be compatible with PHP 8 and recent versions of Laravel. A small, fluent wrapper for [Restcord](http://www.restcord.com). README Contents --------------- [](#readme-contents) - [Features](#features) - [Installation](#installation) - [Usage](#usage) - [Guilds](#guilds) - [Adding Bots To Guilds](#adding-bots-to-guilds) - [Creating Webhooks](#creating-webhooks) Features ======== [](#features) - Integrates Restcord with [Laravel Socialite](http://socialiteproviders.github.io) so currently OAuth'd user is used for api calls (when `sessionHasDiscordToken` middleware is used) - Handles creation of webhooks via OAuth (no bot required) - Handles adding bots to to guilds via OAuth (no websocket connection required) - Obtain information about a member's relationship with a guild (roles, permissions, etc.) Installation ============ [](#installation) 1. Install package ``` composer require more-cores/laravel-restcord:2.* ``` 2. Define the `DISCORD_BOT_TOKEN` environmental variable. 3. Add the middleware `sessionHasDiscordToken` for the routes where you need to use the current OAuth'd user's credentials to interact with the Discord API. This is required because session information is not available in a ServiceProvider. 4. For Laravel <= 5.4, register the [service provider](http://laravel.com/docs/master/providers) in `config/app.php` ``` 'providers' => [ ... LaravelRestcord\ServiceProvider::class, ] ``` Environment Variables --------------------- [](#environment-variables) - `DISCORD_BOT_KEY` - `DISCORD_BOT_SECRET` - `DISCORD_BOT_TOKEN` - `DISCORD_KEY` - `DISCORD_SECRET` Bot key/secret will be used for callback endpoints related to adding a bot or creating a webhook as well as when the application is running in the console such as queue workers and cron. Usage ===== [](#usage) This documentation assumes your users are logging in via the [Discord driver](https://socialiteproviders.netlify.com/providers/discord.html) for [Laravel Socialite](https://laravel.com/docs/master/socialite). Anytime you see `$discord` in this documentation it is assumed to be an instance of `LaravelRestcord\Discord\Discord::class` which is available from Laravel's IOC container. Guilds ------ [](#guilds) Get a list of guilds the current user has access to: ``` $discord->guilds() // Guild[] ``` Get information about a user's relationship with a guild ``` $guild->userCan(Permission::KICK_MEMBERS); // bool - uses permissions of the currently oauth'd user $member = $guild->getMemberById($discordUserId); // \LaravelRestcord\Discord\Member $member->roles(); // \LaravelRestcord\Discord\Role[] $member->joinedAt(); // Carbon ``` Adding Bots To Guilds --------------------- [](#adding-bots-to-guilds) This implementation uses the [Advanced Bot Authorization](https://discord.com/developers/docs/topics/oauth2#advanced-bot-authorization) flow to add the bot to a guild. You should have the **Require OAuth2 Code Grant** option *enabled* on your app's settings. ``` use LaravelRestcord\Discord\HandlesBotAddedToGuild; use Illuminate\Http\RedirectResponse; class BotAddedToDiscordGuild { use HandlesBotAddedToGuild; public function botAdded(Guild $guild) : RedirectResponse { // do something with the guild information the bot was added to return redirect('/to/this/page'); } } ``` Next, add a binding to your `AppServiceProvider` so the package knows which class to pass the guild information to when the user returns to your web site. ``` $this->app->bind(HandlesBotAddedToGuild::class, BotAddedToDiscordGuild::class); ``` Now you're ready to direct the user to Discord's web site so they can select the guild to add the bot to: ``` public function redirecToAddBot(Guild $guild = null) { // Reference https://discordapi.com/permissions.html to determine // the permissions your bot needs Discord::redirecToAddBot($permissions, $guild->?id()??null); } ``` if you wan to show a button in th ui ``` public function redirecToAddBot(Guild $guild = null) { // Reference https://discordapi.com/permissions.html to determine // the permissions your bot needs $url = Discord::addBotUrl($permissions, $guild->?id()??null); return $url; // show this in href link } ``` This package handles the routing needs, but you need to whitelist the callback URL for this to work. Add `http://MY-SITE.com/discord/bot-added` to your [application's redirect uris](https://discord.com/developers/applications/me). Your handler will be trigger when the bot has been added to a guild. > You will be able to send messages via this bot once it has established a web socket connection. It only has to do this once, so it's a common practice to use the below code snippet to do so: ``` "use strict"; var TOKEN="PUT YOUR TOKEN HERE"; fetch("https://discord.com/api/v7/gateway").then(function(a){return a.json()}).then(function(a){var b=new WebSocket(a.url+"/?encoding=json&v=6");b.onerror=function(a){return console.error(a)},b.onmessage=function(a){try{var c=JSON.parse(a.data);0===c.op&&"READY"===c.t&&(b.close(),console.log("Successful authentication! You may now close this window!")),10===c.op&&b.send(JSON.stringify({op:2,d:{token:TOKEN,properties:{$browser:"b1nzy is a meme"},large_threshold:50}}))}catch(a){console.error(a)}}}); ``` Creating Webhooks ----------------- [](#creating-webhooks) Because we're using OAuth to create webhooks, the user will be directed to Discord's web site to select the guild/channel. This package handles interpreting the request/response lifecycle for this, so all you need to do is build a handler: ``` use LaravelRestcord\Discord\HandlesDiscordWebhooksBeingCreated; use Illuminate\Http\RedirectResponse; class Subscribe { use HandlesDiscordWebhooksBeingCreated; public function webhookCreated(Webhook $webhook) : RedirectResponse { // $webhook->token(); // Here you should save the token for use later when activating the webhook return redirect('/to/this/page'); } } ``` Next, add a binding to your `AppServiceProvider` so the package knows which class to pass the webhook data to when the user returns to your web site. ``` $this->app->bind(HandlesDiscordWebhooksBeingCreated::class, DiscordChannelAdded::class); ``` Now you're ready to direct the user to Discord's web site to create the webhook: ``` public function createWebhook() { // redirects the user to Discord's interface for selecting // a guild and channel for the webhook Discord::redirectToCreateWebhook(); //for url $url = Discord::addWebHookUrl(); } ``` This package handles the routing needs, but you need to whitelist the callback URL for this to work. Add `http://MY-SITE.com/discord/create-webhook` to your [application's redirect uris](https://discord.com/developers/applications/me). Your handler will be trigger when the webhook is created. ### Health Score 27 — LowBetter than 49% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity11 Limited adoption so far Community10 Small or concentrated contributor base Maturity58 Maturing project, gaining track record Bus Factor1 Top contributor holds 80.8% 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 ~12 days Total 6 Last Release 1148d ago PHP version history (2 changes)1.0.3PHP ^7.3|^8.0 1.0.9PHP ^7.3|^8.0|^8.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/b13f5cf50091fa4278e11003a02fccc7b0c4f5ee067c914a41c5b160afaca35f?d=identicon)[sleepfinance](/maintainers/sleepfinance) --- Top Contributors [![bkuhl](https://avatars.githubusercontent.com/u/524933?v=4)](https://github.com/bkuhl "bkuhl (105 commits)")[![ofumbi](https://avatars.githubusercontent.com/u/4081256?v=4)](https://github.com/ofumbi "ofumbi (13 commits)")[![F4brizio](https://avatars.githubusercontent.com/u/68043260?v=4)](https://github.com/F4brizio "F4brizio (8 commits)")[![alexknutson](https://avatars.githubusercontent.com/u/905228?v=4)](https://github.com/alexknutson "alexknutson (4 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/sleepfinance-laravel-restcord/health.svg) ``` [![Health](https://phpackages.com/badges/sleepfinance-laravel-restcord/health.svg)](https://phpackages.com/packages/sleepfinance-laravel-restcord) ``` ### Alternatives [joselfonseca/lighthouse-graphql-passport-auth Add GraphQL types and mutations for login and recover password functionalities 234769.9k1](/packages/joselfonseca-lighthouse-graphql-passport-auth)[revolution/laravel-bluesky Bluesky(AT Protocol) for Laravel 4317.3k](/packages/revolution-laravel-bluesky)[revolution/laravel-line-sdk LINE SDK for Laravel 2235.8k](/packages/revolution-laravel-line-sdk)[marshmallow/laravel-facebook-webhook A package to retrieve Facebook Leads with webhooks & Graph API in Laravel. 123.2k](/packages/marshmallow-laravel-facebook-webhook) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)