janyksteenbeek/laravel-sendinblue-sync

One-way synchronization of contact fields towards Sendinblue

v0.1 2023-03-02 08:52 UTC

Requires

• php: ^8.1
• illuminate/contracts: ^9.0|^10.0
• sendinblue/api-v3-sdk: ^8.4
• spatie/laravel-package-tools: ^1.14.0

Requires (Dev)

• laravel/pint: ^1.0
• nunomaduro/collision: ^6.0
• nunomaduro/larastan: ^2.0.1
• orchestra/testbench: ^7.0
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• spatie/laravel-ray: ^1.26

MIT

• Janyk Steenbeek

• synchronization
• laravel
• sendinblue
• janyksteenbeek
• laravel-sendinblue-sync

README

One-way synchronization of contact fields in your Laravel application towards the Sendinblue marketing software.

Installation

You can install the package via composer:

composer require janyksteenbeek/laravel-sendinblue-sync

You can publish the config file with:

php artisan vendor:publish --tag="sendinblue-sync-config"

Set all the required values in the config file or in your environment variables. See section "Setup" for more information.

Next, add the trait to your User model:

use Janyk\LaravelSendinblueSync\Traits\IsSendinblueContact;

class User extends Authenticatable
{
    use IsSendinblueContact;
}

Setup instructions

1. Follow the installation instructions to include the package in your application.
2. Before you can use this package, you need to generate an API token. You can do this here: https://app.sendinblue.com/settings/keys/api/
3. Add the API token to your .env file as SENDINBLUE_KEY.
4. Make sure you have a User model in your application. This model should have a sendinblue_id and email column. This column will be used to store the Sendinblue ID of the contact and the email of the contact. You can modify these fields in the config.
5. Make sure the other fields you want to sync with Sendinblue are present on your User model. You can change these mapping of those fields in the config file. In the config file, you can also set any custom fields in case you need those.
6. Add the IsSendinblueContact trait to your User model.

Security Vulnerabilities

If you are an outside collaborator and discover a security vulnerability within this repository, please send an e-mail to our security team via [e-mail]. Do not use GitHub Issues to report security vulnerabilities. All security vulnerabilities will be promptly addressed. Please adhere to the Webmethod Coordinated Vulnerability Disclosure guidelines at all times.

Credits

• Janyk Steenbeek
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Disclaimer

This package is not affiliated with or endorsed by SENDINBLUE or any of its affiliates. The use of the trademark SENDINBLUE is solely for the purpose of identifying the company and its products. Any references to SENDINBLUE are made strictly for identification purposes and do not imply any endorsement or sponsorship by SENDINBLUE