PHPackages                             dinhsan/laravel-mautic-api - 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. [Mail & Notifications](/categories/mail)
4. /
5. dinhsan/laravel-mautic-api

ActiveLibrary[Mail & Notifications](/categories/mail)

dinhsan/laravel-mautic-api
==========================

Free and Open Source Marketing Automation API

3.0.1(2y ago)07MITPHPPHP ^8.0.2

Since May 15Pushed 2y agoCompare

[ Source](https://github.com/dinhsan2000/laravel-mautic-api)[ Packagist](https://packagist.org/packages/dinhsan/laravel-mautic-api)[ RSS](/packages/dinhsan-laravel-mautic-api/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (4)Versions (3)Used By (0)

Mautic API in Laravel 9.
========================

[](#mautic-api-in-laravel-9)

Free and Open Source Marketing Automation API

Requirements
------------

[](#requirements)

- Laravel ^9.0
- PHP ^8.0.2 or newer
- cURL support

Mautic Setup
------------

[](#mautic-setup)

The API must be enabled in Mautic.

Within Mautic, go to the Configuration page (located in the Settings menu) and under API Settings enable Mautic's API. You can also choose which OAuth2 protocol to use here.

After saving the configuration, go to the API Credentials page (located in the Settings menu) and create a new client. Enter the `callback/redirect` URI ( must be `https://your-app.com/mautic/application/register`) that the request will be sent from. Click Apply then copy the `Client ID` and `Client Secret` to the application that will be using the API.

Installation
------------

[](#installation)

First, you'll need to require the package with Composer:

```
composer require dinhsan/laravel-mautic-api
```

Aftwards, run `composer update` from your command line.

Then, update `config/app.php` by adding an entry for the service provider.

```
'providers' => [
	// ...
	Triibo\Mautic\MauticServiceProvider::class,
],
```

Then, register class alias by adding an entry in aliases section

```
'aliases' => [
    // ...
    'Mautic' => Triibo\Mautic\Facades\Mautic::class,
],
```

Finally, from the command line run `php artisan vendor:publish --provider="Triibo\Mautic\MauticServiceProvider"` to publish the default configuration file. This will publish a configuration file name `mautic.php`, `consumer migration` and `consumer model`.

Then, run `php artisan migrate` migration command to create consumer table in your database.

Configuration
-------------

[](#configuration)

You need to add your `client id`, `client secret` and `callback url` for OAuth2 or `username` and `password` for BasicAuth in `config/mautic.php`. Or put it in your `.env` file.

```
## OAuth2
MAUTIC_BASE_URL="https://your-mautic.com"
MAUTIC_PUBLIC_KEY="publicKey"
MAUTIC_SECRET_KEY="secretKey"
MAUTIC_CALLBACK="https://your-app.com/mautic/application/register"
## or BasicAuth
MAUTIC_BASE_URL="https://your-mautic.com"
MAUTIC_USERNAME="username"
MAUTIC_PASSWORD="password"

```

Authorization
-------------

[](#authorization)

This Library only supports `OAuth2` and `BasicAuth` Authentication. For OAuth2 you need to create a `OAuth2` client in order to use the api.

Registering Application
-----------------------

[](#registering-application)

In order to register you application with mautic ping this url this is one time registration.

```
http://your-app.com/mautic/application/register
```

Usage
=====

[](#usage)

Add Mautic Facade in your controller.

```
use Triibo\Mautic\Facades\Mautic;
```

#### Send a request to mautic ( Example )

[](#send-a-request-to-mautic--example-)

Create a new contact in mautic.

```
$params = array(
    'firstname' => 'Prince',
    'lastname'  => 'Ali Khan',
    'email'     => 'princealikhan08@gmail.com'
);

Mautic::request('POST','contacts/new',$params);
```

Get List of all contacts

```
Mautic::request('GET','contacts');
```

Get a unique contact

```
Mautic::request('GET','contacts/1');
//where 1 is unique id for a contact.
```

Delete a contact

```
Mautic::request('Delete','contacts/1/delete');
```

##### And many more endpoints support by mautic.

[](#and-many-more-endpoints-support-by-mautic)

### List of Endpoints supported by Mautic.

[](#list-of-endpoints-supported-by-mautic)

#### Assets

[](#assets)

```
[
    "assets",
    "assets/new",
    "assets/{asset_id}",
    "assets/{asset_id}/edit",
    "assets/{asset_id}/delete"
]
```

#### Campaigns

[](#campaigns)

```
[
    "campaigns",
    "campaigns/new",
    "campaigns/{campaign_id}",
    "campaigns/{campaign_id}/contacts",
    "campaigns/clone/{campaign_id}",
    "campaigns/{campaign_id}/edit",
    "campaigns/{campaign_id}/delete",
    "campaigns/{campaign_id}/contact/{contact_id}/add",
    "campaigns/{campaign_id}/contact/{contact_id}/remove"
]
```

#### Categories

[](#categories)

```
[
    "categories",
    "categories/new",
    "categories/{category_id}",
    "categories/{category_id}/edit",
    "categories/{category_id}/delete"
]
```

#### Companies

[](#companies)

```
[
    "companies",
    "companies/new",
    "companies/{company_id}",
    "companies/{company_id}/edit",
    "companies/{company_id}/delete",
    "companies/{company_id}/contact/{contact_id}/add",
    "companies/{company_id}/contact/{contact_id}/remove"
]
```

#### Contacts

[](#contacts)

```
[
    "contacts",
    "contacts/batch/new",
    "contacts/batch/edit",
    "contacts/batch/delete",
    "contacts/new",
    "contacts/{contact_id}",
    "contacts/{contact_id}/edit",
    "contacts/{contact_id}/delete",
    "contacts/{contact_id}/dnc/{channel}/add",
    "contacts/{contact_id}/dnc/{channel}/remove",
    "contacts/{contact_id}/utm/add",
    "contacts/{contact_id}/utm/{utm_id}/remove",
    "contacts/{contact_id}/points/plus/{points}",
    "contacts/{contact_id}/points/minus/{points}",
    "contacts/list/owners",
    "contacts/list/fields",
    "contacts/{contact_id}/notes",
    "contacts/{contact_id}/segments",
    "contacts/{contact_id}/campaigns"
    "contacts/{contact_id}/events",
    "contacts/{contact_id}/activity",
    "contacts/activity",
    "contacts/{contact_id}/companies",
    "contacts/{contact_id}/devices"
]
```

#### Data

[](#data)

```
[
    "data",
    "data/{type}",
    "data/emails.in.time",
    "data/sent.email.to.contacts",
    "data/most.hit.email.redirects"
]
```

#### Dynamic Content

[](#dynamic-content)

```
[
    "dynamiccontents",
    "dynamiccontents/new",
    "dynamiccontents/{dynamiccontent_id}",
    "dynamiccontents/{dynamiccontent_id}/edit",
    "dynamiccontents/{dynamiccontent_id}/delete"
]
```

#### Emails

[](#emails)

```
[
    "emails",
    "emails/new",
    "emails/{email_id}",
    "emails/{email_id}/edit",
    "emails/{email_id}/delete",
    "emails/{email_id}/send",
    "emails/reply/{tracking_hash}"
]
```

#### Fields

[](#fields)

```
[
    "fields/company",
    "fields/company/new",
    "fields/company/{company_id}",
    "fields/company/{company_id}/edit",
    "fields/company/{company_id}/delete",
    "fields/contact",
    "fields/contact/new",
    "fields/contact/{contact_id}",
    "fields/contact/{contact_id}/edit",
    "fields/contact/{contact_id}/delete"
]
```

#### Files

[](#files)

```
[
    "files/images",
    "files/{dir}/new",
    "files/{dir}/{file}/delete"
]
```

#### Forms

[](#forms)

```
[
    "forms",
    "forms/new",
    "forms/{form_id}",
    "forms/{form_id}/edit",
    "forms/{form_id}/delete",
    "forms/{form_id}/fields/delete",
    "forms/{form_id}/actions/delete",
    "forms/{form_id}/submissions",
    "forms/{form_id}/submissions/contact/{contact_id}",
    "forms/{form_id}/submissions/{submission_id}"
]
```

#### Marketing Messages

[](#marketing-messages)

```
[
    "messages",
    "messages/new",
    "messages/{message_id}",
    "messages/{message_id}/edit",
    "messages/{message_id}/delete"
]
```

#### Notes

[](#notes)

```
[
    "notes",
    "notes/new",
    "notes/{note_id}",
    "notes/{note_id}/edit",
    "notes/{note_id}/delete"
]
```

#### Notifications

[](#notifications)

```
[
    "notifications",
    "notifications/new",
    "notifications/{notification_id}",
    "notifications/{notification_id}/edit",
    "notifications/{notification_id}/delete"
]
```

#### Pages

[](#pages)

```
[
    "pages",
    "pages/new",
    "pages/{page_id}",
    "pages/{page_id}/edit",
    "pages/{page_id}/delete"
]
```

#### Points Actions

[](#points-actions)

```
[
    "points",
    "points/new",
    "points/{point_id}",
    "points/{point_id}/edit",
    "points/{point_id}/delete",
    "points/actions/types",
    "points/triggers",
    "points/triggers/new",
    "points/triggers/{point_id}",
    "points/triggers/{point_id}/edit",
    "points/triggers/{point_id}/delete",
    "points/triggers/{point_id}/events/delete",
    "points/triggers/events/types"
]
```

#### Reports

[](#reports)

```
[
    "reports",
    "reports/{report_id}"
]
```

#### Roles

[](#roles)

```
[
    "roles",
    "roles/new",
    "roles/{role_id}",
    "roles/{role_id}/edit",
    "roles/{role_id}/delete"
]
```

#### Segments

[](#segments)

```
[
    "segments",
    "segments/new",
    "segments/{segment_id}",
    "segments/{segment_id}/edit",
    "segments/{segment_id}/delete",
    "segments/{segment_id}/contact/{contact_id}/add",
    "segments/{segment_id}/contact/{contact_id}/remove"
]
```

#### Text messages

[](#text-messages)

```
[
    "smses",
    "smses/new",
    "smses/{sms_id}",
    "smses/{sms_id}/edit",
    "smses/{sms_id}/delete",
    "smses/{sms_id}/contact/{contact_id}/send"
]
```

#### Stages

[](#stages)

```
[
    "stages",
    "stages/new",
    "stages/{stage_id}",
    "stages/{stage_id}/edit",
    "stages/{stage_id}/delete",
    "stages/{stage_id}/contact/{contact_id}/add",
    "stages/{stage_id}/contact/{contact_id}/remove"
]
```

#### Stats

[](#stats)

```
[
    "stats",
    "stats/{table}"
]
```

#### Tags

[](#tags)

```
[
    "tags",
    "tags/new",
    "tags/{tag_id}",
    "tags/{tag_id}/edit",
    "tags/{tag_id}/delete"
]
```

#### Themes

[](#themes)

```
[
    "themes",
    "themes/new",
    "themes/{theme_name}",
    "themes/{theme_name}/delete"
]
```

#### Tweets

[](#tweets)

```
[
    "tweets",
    "tweets/new",
    "tweets/{tweet_id}",
    "tweets/{tweet_id}/edit",
    "tweets/{tweet_id}/delete"
]
```

#### Users

[](#users)

```
[
    "users",
    "users/new",
    "users/{user_id}",
    "users/{user_id}/edit",
    "users/{user_id}/delete",
    "users/self",
    "users/{user_id}/permissioncheck"
]
```

#### Webhooks

[](#webhooks)

```
[
    "hooks",
    "hooks/new",
    "hooks/{hook_id}",
    "hooks/{hook_id}/edit",
    "hooks/{hook_id}/delete",
    "hooks/triggers"
]
```

Please refer to [Documentation](https://developer.mautic.org). for all customizable parameters.

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity50

Maturing project, gaining track record

 Bus Factor2

2 contributors hold 50%+ of commits

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 ~0 days

Total

2

Last Release

1093d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/c0b38161fcf7cf217cc001044eeb08a3feea23271772751d12a815be54e5e0cf?d=identicon)[dinhsan](/maintainers/dinhsan)

---

Top Contributors

[![CostaMateus](https://avatars.githubusercontent.com/u/19847297?v=4)](https://github.com/CostaMateus "CostaMateus (23 commits)")[![princealikhan](https://avatars.githubusercontent.com/u/6194551?v=4)](https://github.com/princealikhan "princealikhan (10 commits)")[![dinhsan2000](https://avatars.githubusercontent.com/u/39308487?v=4)](https://github.com/dinhsan2000 "dinhsan2000 (6 commits)")[![inkas](https://avatars.githubusercontent.com/u/10758776?v=4)](https://github.com/inkas "inkas (5 commits)")[![harryspink](https://avatars.githubusercontent.com/u/3799258?v=4)](https://github.com/harryspink "harryspink (3 commits)")[![backstageel](https://avatars.githubusercontent.com/u/1692858?v=4)](https://github.com/backstageel "backstageel (3 commits)")[![joao-pedro-alves](https://avatars.githubusercontent.com/u/6307532?v=4)](https://github.com/joao-pedro-alves "joao-pedro-alves (1 commits)")

---

Tags

apilaravellaravel 9automationemailMauticmarketingsync

### Embed Badge

![Health badge](/badges/dinhsan-laravel-mautic-api/health.svg)

```
[![Health](https://phpackages.com/badges/dinhsan-laravel-mautic-api/health.svg)](https://phpackages.com/packages/dinhsan-laravel-mautic-api)
```

###  Alternatives

[princealikhan/laravel-mautic-api

Free and Open Source Marketing Automation API

415.9k](/packages/princealikhan-laravel-mautic-api)[erag/laravel-disposable-email

A Laravel package to detect and block disposable email addresses.

226102.4k](/packages/erag-laravel-disposable-email)[hafael/azure-mailer-driver

Supercharge your Laravel or Symfony app with Microsoft Azure Communication Services (ACS)! Effortlessly add email, chat, voice, video, and telephony-over-IP for next-level communication. 🚀

14109.2k](/packages/hafael-azure-mailer-driver)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)