Mautic

Companies

Contacts

Insert a script tag with the provided URL in the head of the document

Parse text to JSON

Creates an XMLHttpRequest for cross domain requests with cookies.

Create CORS Request

Logs messages using MauticJS

Transform object properties into a key=value string

Called prior to going back to a previous page in the form

onMessageSet

Called during error marking

List available webhook triggers

Delete Webhook

Create a new webhook if the given ID does not exist and clears all the webhook information, adds the information from the request.

Edit Webhook

Fail if the webhook with the given ID does not exist and updates the webhook field values with the values from the request.

Create Webhook

List Webhooks

Get Webhook

Check User Permissions

Get Self User

Delete User

Create a new user if the given ID does not exist and clears all the user information, or updates the information from the request.

Edit or Create User

Update user field values with the values from the request.

Edit User

Create User

List Contact Users

Get User

Delete Tweet

Creates a new tweet if the ID does not exist or updates an existing tweet.

Edit or Create a Tweet

Updates an existing tweet if the ID exists.

Update Tweet

Create Tweet

List Tweets

Get Tweet

Create Theme

Get List of themes

Set Temporary File Path

Returns the zip file in the response with the application/zip header on success or a JSON response body with error messages on fail.

Get theme

Delete Tag

Create a new tag if the given ID does not exist and clears all the tag information, or updates the tag information if the ID exists.

Edit or Create Tag

Update the tag field values if the ID exists.

Edit Tag

Create Tag

List Tags

Get Tag

Get Stats from a table

Remove Contact from a Stage

Add Contact to a Stage

Delete Stage

Creates a stage if the ID does not exist, or updates the stage information

Edit or create a stage

Updates the stage information if the ID exists

Edit an existing stage

Create Stage

List Contact Stages

Get Stage by ID

Send SMS to Contact

Delete Text message

Create a new sms if the given ID does not exist and clears all the sms information, adds the information from the request.

Edit a new sms

Fail if the sms with the given ID does not exist and updates the sms field values with the values from the request.

Create Text message

List Text messages

Get Text message

Remove Contact from a Segment

Add Contacts to a Segment

Add Contact to a Segment

Delete Segment

Creates a segment if the given ID does not exist and clears all the segment information, adds the information from the request.

Edit or Create a Segment

Fails if the segment with the given ID does not exist and updates the segment field values with the values from the request.

Edit a Segment

Create Segment

Returns a list of contact segments available to the user. This list is not filterable.

List Contact Segments

Get Segment by ID

Delete Role

Create a new role if the given ID does not exist and clears all the role information, adds the information from the request.

Edit Role

Fail if the role with the given ID does not exist and updates the role field values with the values from the request.

Create Role

List Contact Roles

Get Role

Returns a list of contact reports available to the user. This list is not filterable.

List Reports

Get Point Trigger Event Types

Delete Point Trigger Events

Delete Point Trigger

Create a new point trigger if the given ID does not exist and clear all the point trigger information, adding the information from the request.

Edit Point Trigger

Update the point trigger field values with the values from the request.

Create Point Trigger

List Point Triggers

Get Point Trigger by ID

Get Point Action Types

Delete Point Action

Creates a point action if the given ID does not exist and updates the point action with the request data.

Edit Point Action or Create New

Updates the point action with the request data if the ID exists.

Edit Point Action

Create Point Action

List Point Actions

Get an individual point action by ID

Delete Page

Creates a new page if the given ID does not exist and clears all the page information, or updates the page if the ID exists.

Edit or create a page

Fails if the page with the given ID does not exist and updates the page field values with the values from the request.

Edit an existing page

Create a new page

List Pages

Get Page

Delete Notification

Creates a new notification if the ID does not exist or updates the existing notification.

Edit or Create Notification

Updates an existing notification with the given ID.

Update Notification

Create Notification

List Notifications

Get Notification

Delete Note

Create a new note if the given ID does not exist and clears all the note information, or updates the note with the information from the request.

Edit or Create a Note

Salesforce

HubSpot

Microsoft Dynamics 365

Zoho CRM

Pipedrive

Freshsales

Keap

SugarCRM

Outreach

Xero

ActiveCampaign

Capsule CRM

Salesloft

Agile CRM

SalesForce Pardot

SharpSpring

Teamleader

Insightly

Zendesk

Sage Accounting

Attio

Copper

Intercom

Zoho Books

Front

Close

Freshdesk

Breezy HR

Affinity

Exact Online

# Realtime Full two-way Sync of Companies

This scenario enables your application to fully sync Companies between your app and any external application in both directions. It handles the initial import/export of Companies and then sends events when a Company is created, updated, or deleted on any side, as close to real-time as possible.

Company fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Companies in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Companies to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Companies

Bi-directional realtime sync of Companies with records deduplication

Mailchimp

NetSuite

AWeber

Apollo.io

GoHighLevel

Ontraport

Jobnimbus

# Continuous Import of Contacts to Your App

This scenario enables your application to continuously sync Contacts from any external application to your app's API. It handles the initial import of Contacts and keeps them synchronized when a Contact is created, updated, or deleted in the external application.

When receiving Contacts data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Contacts to my App

Import Contacts and receive created/updated or deleted events

# Delete Company

This scenario allows your application to delete a Company from any external application. 
You will pass ID of the Company you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Company API call**:
   - Call Integration.app REST API or SDK with ID of the Company you want to delete and Integration.app will send the correct request to the external app.


Delete Company

Deletes Company in any external application

# Get all Companies

This scenario enables your application to get a complete list of Companies from any external application to your app's API in the same way. 

When receiving Companies data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Companies along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Companies page by page.


Get all Companies

Imports all Companies from any external application to your App.

# Get all Contacts

This scenario enables your application to get a complete list of Contacts from any external application to your app's API in the same way. 

When receiving Contacts data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Contacts along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Contacts page by page.


Get all Contacts

Imports all Contacts from any external application to your App.

Woosender

# Enrich newly created Contacts

This scenario enables your application to enrich with the new data any newly createad Contacts in external application. 

It handles subscription to the created events and Contact fields mapping from your application's schema to the application-specific schema.

## How It Works
1. **Configuration**:
   - You will setup the schema of fields that you wish to enrich Contact with and configure mapping to our default model.
   - If needed - your customer can customize this mapping based on their specific setup or even custom fields

2. **Enable receiving of Contact created events**:
   - Enable subscription via a single API or SDK call to continuously receive created events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

2. **React to created Contacts**:
   - Integration.app flow will be launched when new Contact is created
   - It will send existing data to your app API, so you can decide how to enrich. Your API will return enriched data.
   - Integration.app will send enriched data to the external application mapped to the supported format based on the configuration above


Continuously Enrich Contacts

Receive all newly created contacts, send it to your app API to enrich with the new data and update contact back

# Create Company

This scenario allows your application to create a Company in any external application in the same way. 
You will pass Company fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.


## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to create Company with and configure mapping to our default model

2. **Create Company API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Company data into a format compatible with the selected external application.
   - It then makes an API call to create the Company in that specific application.


Create Company

Creates Company in any external application

# Continuous Import of Companies to Your App

This scenario enables your application to continuously sync Companies from any external application to your app's API. It handles the initial import of Companies and keeps them synchronized when a Company is created, updated, or deleted in the external application.

When receiving Companies data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Companies to my App

Import Companies and receive created/updated or deleted events

# Delete Contact

This scenario allows your application to delete a Contact from any external application. 
You will pass ID of the Contact you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Contact API call**:
   - Call Integration.app REST API or SDK with ID of the Contact you want to delete and Integration.app will send the correct request to the external app.


Delete Contact

Deletes Contact in any external application

# Create Contact

This scenario allows your application to create a Contact in any external application in the same way. 
You will pass Contact fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.


## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to create Contact with and configure mapping to our default model

2. **Create Contact API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Contact data into a format compatible with the selected external application.
   - It then makes an API call to create the Contact in that specific application.


Create Contact

Creates Contact in any external application

# Update Contact

This scenario allows your application to update a Contact in any external application in the same way. 
You will pass  ID of the Contact you want to update and Contact fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.

## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to update Contact with and configure mapping to our default model

2. **Create Contact API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured and ID. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Contact data into a format compatible with the selected external application.
   - It then makes an API call to update the Contact in that specific application.


Update Contact

Updates Contact in any external application

# Enrich newly created Companies

This scenario enables your application to enrich with the new data any newly createad Companies in external application. 

It handles subscription to the created events and Company fields mapping from your application's schema to the application-specific schema.

## How It Works
1. **Configuration**:
   - You will setup the schema of fields that you wish to enrich Company with and configure mapping to our default model.
   - If needed - your customer can customize this mapping based on their specific setup or even custom fields

2. **Enable receiving of Company created events**:
   - Enable subscription via a single API or SDK call to continuously receive created events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

2. **React to created Companies**:
   - Integration.app flow will be launched when new Company is created
   - It will send existing data to your app API, so you can decide how to enrich. Your API will return enriched data.
   - Integration.app will send enriched data to the external application mapped to the supported format based on the configuration above


Continuously Enrich Companies

Receive all newly created companies, send it to your app API to enrich with the new data and update company back

Mautic API Integration Profile

Getting Started

Data Collections

Operations

Integration Scenarios