Tip
Need help? Join our Discord or email [email protected] for personalized support.
The Bento Laravel SDK makes it quick and easy to send emails and track events in your Laravel applications. We provide powerful and customizable APIs that can be used out-of-the-box to manage subscribers, track events, and send transactional emails. We also expose low-level APIs so that you can build fully custom experiences.
Get started with our 📚 integration guides, or 📘 browse the SDK reference.
🐶 Battle-tested by High Performance SQLite (a Bento customer)!
❤️ Thank you @aarondfrancis for your contribution.
❤️ Thank you @ziptied for your contribution.
- Laravel Mail Integration: Seamlessly integrate with Laravel's mail system to send transactional emails via Bento.
- Event Tracking: Easily track custom events and user behavior in your Laravel application.
- Subscriber Management: Import and manage subscribers directly from your Laravel app.
- API Access: Full access to Bento's REST API for advanced operations.
- Laravel-friendly: Designed to work smoothly with Laravel's conventions and best practices.
- PHP 8.0+
- Laravel 10.0+
- Bento API Keys
Install the package via Composer:
composer require bentonow/bento-laravel-sdk- Publish the configuration file:
php artisan vendor:publish --tag bentonow- Add a new mailer definition in
config/mail.php:
'bento' => [
'transport' => 'bento',
],- Add your Bento API keys to your
.envfile:
BENTO_PUBLISHABLE_KEY="bento-publishable-key"
BENTO_SECRET_KEY="bento-secret-key"
BENTO_SITE_UUID="bento-site-uuid"
MAIL_MAILER="bento"Track custom events in your application:
use Bentonow\BentoLaravel\Facades\Bento;
use Bentonow\BentoLaravel\DataTransferObjects\EventData;
$data = collect([
new EventData(
type: '$completed_onboarding',
email: "[email protected]",
fields: [
"first_name" => "John",
"last_name" => "Doe"
]
)
]);
return Bento::trackEvent($data)->json();Import subscribers into your Bento account:
use Bentonow\BentoLaravel\Facades\Bento;
use Bentonow\BentoLaravel\DataTransferObjects\ImportSubscribersData;
$data = collect([
new ImportSubscribersData(
email: "[email protected]",
first_name: "John",
last_name: "Doe",
tags: ["lead", "mql"],
removeTags: ["customers"],
fields: ["role" => "ceo"]
),
]);
return Bento::importSubscribers($data)->json();Search your site for a subscriber:
use Bentonow\BentoLaravel\Facades\Bento;
return Bento::findSubscriber("[email protected]")->json();Creates a subscriber in your account and queues them for indexing:
use Bentonow\BentoLaravel\Facades\Bento;
use Bentonow\BentoLaravel\DataTransferObjects\CreateSubscriberData;
$data = collect([
new CreateSubscriberData(email: "[email protected]")
]);
return Bento::createSubscriber($data)->json();Execute a command and change a subscriber's data:
use Bentonow\BentoLaravel\Facades\Bento;
use Bentonow\BentoLaravel\DataTransferObjects\CommandData;
use Bentonow\BentoLaravel\Enums\Command;
$data = collect([
new CommandData(Command::REMOVE_TAG, "[email protected]", "test")
]);
return Bento::subscriberCommand($data)->json();Returns a list of tags in your account:
use Bentonow\BentoLaravel\Facades\Bento;
return Bento::getTags()->json();Creates a custom tag in your account:
use Bentonow\BentoLaravel\Facades\Bento;
use Bentonow\BentoLaravel\DataTransferObjects\CreateTagData;
$data = new CreateTagData(name: "example tag");
return Bento::createTag($data)->json();The field model is a simple named key value pair, think of it as a form field:
use Bentonow\BentoLaravel\Facades\Bento;
return Bento::getFields()->json();Creates a custom field in your account:
use Bentonow\BentoLaravel\Facades\Bento;
use Bentonow\BentoLaravel\DataTransferObjects\CreateFieldData;
$data = new CreateFieldData(key: "last_name");
return Bento::createField($data)->json();Returns a list of broadcasts in your account:
use Bentonow\BentoLaravel\Facades\Bento;
return Bento::getBroadcasts()->json();Create new broadcasts to be sent:
use Bentonow\BentoLaravel\Facades\Bento;
use Bentonow\BentoLaravel\DataTransferObjects\CreateBroadcastData;
use Bentonow\BentoLaravel\DataTransferObjects\ContactData;
use Bentonow\BentoLaravel\Enums\BroadcastType;
$data = Collect([
new CreateBroadcastData(
name: "Campaign #1 Example",
subject: "Hello world Plain Text",
content: "<p>Hi {{ visitor.first_name }}</p>",
type: BroadcastType::PLAIN,
from: new ContactData(
name: "John Doe",
emailAddress: "[email protected]"
),
inclusive_tags: "lead,mql",
exclusive_tags: "customers",
segment_id: "segment_123456789",
batch_size_per_hour: 1500
),
]);
return Bento::createBroadcast($data)->json();Returns a list of site stats:
use Bentonow\BentoLaravel\Facades\Bento;
return Bento::getSiteStats()->json();Returns a list of a segments stats:
use Bentonow\BentoLaravel\Facades\Bento;
use Bentonow\BentoLaravel\DataTransferObjects\SegmentStatsData;
$data = new SegmentStatsData(segment_id: "123");
return Bento::getSegmentStats($data)->json();Returns an object containing data for a specific report:
use Bentonow\BentoLaravel\Facades\Bento;
use Bentonow\BentoLaravel\DataTransferObjects\ReportStatsData;
$data = new ReportStatsData(report_id: "456");
return Bento::getReportStats($data)->json();Validates the IP or domain name with industry email reputation services to check for delivery issues:
use Bentonow\BentoLaravel\Facades\Bento;
use Bentonow\BentoLaravel\DataTransferObjects\BlacklistStatusData;
$data = new BlacklistStatusData(domain: null, ipAddress: "1.1.1.1");
return Bento::getBlacklistStatus($data)->json();Validates the email address using the provided information to infer its validity:
use Bentonow\BentoLaravel\Facades\Bento;
use Bentonow\BentoLaravel\DataTransferObjects\ValidateEmailData;
$data = new ValidateEmailData(
emailAddress: "[email protected]",
fullName: "John Snow",
userAgent: null,
ipAddress: null
);
return Bento::validateEmail($data)->json();An opinionated Content moderation:
use Bentonow\BentoLaravel\Facades\Bento;
use Bentonow\BentoLaravel\DataTransferObjects\ContentModerationData;
$data = new ContentModerationData("Its just so fluffy!");
return Bento::getContentModeration($data)->json();Guess a subscriber's gender using their first and last name. Best for US users; based on US Census Data:
use Bentonow\BentoLaravel\Facades\Bento;
use Bentonow\BentoLaravel\DataTransferObjects\GenderData;
$data = new GenderData("John Doe");
return Bento::getGender($data)->json();This endpoint attempts to geolocate the provided IP address:
use Bentonow\BentoLaravel\Facades\Bento;
use Bentonow\BentoLaravel\DataTransferObjects\GeoLocateIpData;
$data = new GeoLocateIpData("1.1.1.1");
return Bento::geoLocateIp($data)->json();- The SDK integrates seamlessly with Laravel's mail system for sending transactional emails.
- For event tracking and data importing, use the BentoConnector class.
- All API requests are made using strongly-typed request classes for better type safety.
- The SDK supports Laravel's environment-based configuration for easy setup across different environments.
- For signed emails with return urls, please assign the
bento.signaturemiddleware or theBentoSignatureExclusion::class. This must be before the signed middleware to remove all utm and tracking url params. - Bento does not support
no-replysender addresses for transactional emails. You MUST use an author you have configured as your sender address. - For more advanced usage, refer to the Bento API Documentation.
We welcome contributions! Please see our contributing guidelines for details on how to submit pull requests, report issues, and suggest improvements.
The Bento SDK for Laravel is available as open source under the terms of the MIT License.