Code Monkey home page Code Monkey logo

mauticcontactsourcebundle's Introduction

Mautic Contact Source Latest Stable Version License Build Status

Creates API endpoints for receiving contacts from external sources.

Designed for use by performance marketers who enhance/exchange contacts in mass quantities. Can optionally be used in tandem with it's sibling Mautic Contact Client to discern real-time acceptance criteria with external clients.

Installation & Usage

Choose a release that matches your version of Mautic.

Mautic version Installation
2.12.x composer require thedmsgroup/mautic-contact-source-bundle "^2.12"
2.14.x composer require thedmsgroup/mautic-contact-source-bundle "^2.14"
  1. Install by running the command above or by downloading the appropriate version and unpacking the contents into a folder named /plugins/MauticContactSourceBundle
  2. Go to /s/plugins/reload
  3. After a refresh you will find "Sources" in the main menu, you can dive in and create your first one.

Endpoints

By default your third parties can POST contacts to urls matching this pattern:

/source/{sourceId}/campaign/{campaignId}/contact

Uses these fine libraries:

Features

  • Campaigns: A whitelist of campaigns can be selected for the third party to post into.
  • Campaign Caps: Limit the number of contacts accepted to a campaign within defined time frames.
  • Campaign Finance: Track the cost/revenue of contacts upon ingestion per campaign.
  • Campaign Scrub: Support an optional scrub-rate per campaign which affects the cost/revenue.
  • Caps: Rules to limit the quantity of successful contacts can be received.
  • Logging: Log statistics on contact ingestion, provide charts when viewing a source in the UI.
  • Self-Documentation: Each source (API) generates a public documentation page for a third party (optional).

Todo

  • Campaign Required Fields: The fields being used within a campaign should percolate upward to the Source, updating required fields.
  • Notifications: Third parties should be notified when their API changes (such as an added campaign or required field change).
  • Batch Support: Import multiple contacts at once for improved performance.

Review and refactor for 2.14.x

Overrides to refactor:

  • processRealTime - Refactor to use executioner instead of modified event model. -- Also use event dispatching from client plugin instead of session storage.

mauticcontactsourcebundle's People

Contributors

cykonetic avatar heathdutton avatar scottshipman avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.