Overview

Integrations allow you to extend the platform by subscribing to events.

Integrations endpoint - /integrations

Types of integrations

1. Enrichment - Enrich your data with more information, example - HLR, MNP, email validation etc'
2. Channels - ways to communicate with the audience, example - SMS routes, email servers, voice channels etc'.
3. Utilities - general services like domains for the URL shortener, SMS test tools etc'

Integrations are a way to integrate 3rd party logic into the application.

Components

An integration usually works with 3 type of components -

1. Platform - comm.com
2. Middleware integration - translates comm.com events to the other service (hosted somewhere with web hooks) and vice versa
3. Service provider - provides service (HLR, MNP, domains, email validation, voice, gateways ...) API

Integration events

Integration activated

When an integration is activated the following steps happen

1. The integration receives a call with the required_fields required by it.
   1. The integration replies (synchronously) if the required fields are correct - usually by validating the api key with the service provider.
2. The integration receives an API token with the privileges assigned in it's scope.
3. The platform creates the necessary custom fields required by the integration, if a field with the name already exists it will skip it and use that field for information.

From now on, the integration will receive events.

Integration Deacativation

On the integration page you can select to deactivate it, once selected the following sequence happens.

1. The integration receives a deactivation event
2. The team access token is removed
3. The custom fields remain in your account as to not remove information already processed by the integration.

Events supported

1. Contact Created - when a contact is uploaded to platform
2. SMS Created - when an SMS is sent to platform

Billing

Example billing flow | toggle

Some integrations don't need the service API key they will just use Comm.com API key and will be billed by comm.com. For example:

1. Use activates integration on comm.com
2. Comm.com sends the activation information to Integration middleware
3. Comm.com sends events to middleware (Integration Events)
4. Middleware sends response information
5. Middleware sends billing request to Comm.com API endpoint with activation key.

Example:

1. User activates PingProphet
2. Comm.com checks balance of user > 0
3. Comm.com sends activation to middleware
4. Comm.com sends MNP request to middleware
5. middleware sends MNP request to PP
6. PP Middleware receives response from PP
7. PP sends MNP response to endpoints
8. PP middleware sends MNP cost to bill user

FAQ

What if user runs out of balance on comm.com?

• An event of user out of balance will be sent to middleware,
• Integration will be disabled on comm.com

What is a custom integration?