m3terDocumentation
Schedule a demoLog In

On this page

Creating and Managing Integrations

Setting up an Integration in m3ter consists of two stages:

  • Configuration to control how m3ter data will be synchronized with your external system.

  • Configuration of a Credential, which will allow the Integration to authenticate and connect with an external system.

You can perform both stages of this overall set up in the Console for either Native Integrations or Notification Webhook Integrations:

  • A Native Integration allows you to send billing data for end-customer Accounts in m3ter into your Accounts Receivables systems. For some external systems, you can also send operational data for entities in your m3ter Organization.

  • A Notification Webhook Integration allows you to send out notifications triggered by m3ter system Events to webhooks.

This topic provides general guidance on how to create, review, and manage your Integrations:

Important! Auto-Disabling and Auto-Failure of Integrations: When Native or Notification Webhook Integrations are deployed to production, checks are applied from the m3ter side to both ensure some resilience for integrations runs and to prevent runaway errors. Please review the Integration Run Error Handling and Alerts section below before you deploy your Integrations to your production environment.

Creating and Managing Native Integrations

Creating Native Integrations

You can create Native Integrations for a billing data flow into external systems. For some external systems, you can also choose to set up Integrations to sync operational entity data in m3ter with the external system. For detailed guidance on creating a Native Integration, please see the relevant specific topic in this section:

Reviewing and Managing Native Integrations

When you have set up some Native Integrations, you can use the Integrations section in the Console to review and manage them.

To review and manage Native Integrations:

1. Select Integrations:

The Integrations page opens with All selected by default:

  • You can filter the page by selecting to show only Accounts Receivables or Customer Relationship Management systems.

On the Integrations page, you can review and manage your Integrations with external systems:

  • Quickly identify which systems are integrated with your m3ter Organization:

    • External systems with an integration configured show an amber checkmark.

    • External systems with an integration configured and set up with a valid credential for connecting with the system show a green checkmark.

  • If you're planning to set up an integration:

    • Use a Read docs hotlink to open the topic explaining how to configure an integration for that system.

2. If you want to create a new Native Integration or review and edit the details of an existing, select the tile for the system:

The Integrations page for the external system opens and list any existing integrations:

3. If you want to create a new Native Integration for the external system, select Configure new integration and commence your workflow - see the relevant specific topic in this section of the documentation.

4. If you want to review or edit an existing integration for the system, on the Configurations panel select the Name hotlink text. The Integration details page opens:

This example shows the details for a Bill - Stripe Native Integration. Note that:

  • We can see that the integration is currently DISCONNECTED from the Stripe system:

    • If you want to connect the Integration, select Add credential. A Select one Integration Credential modal appears, which you can use to select the Credential you want to use to connect the integration. See Creating Stripe Integration Credentials.

  • The Configuration data is given in JSON format. You can copy this directly to your clipboard.

5. If you want to edit an existing integration, select the Edit button. The Edit page opens and shows the Entity type and External system at the top of the page.

6. Make the required editing changes and select Update integration. You are returned to the Integration details page.

7. If you want to remove an existing Integration, go back to the Integrations page for the external system and on the Configurations panel select delete:

A confirmation popup appears.

8. Select Yes to confirm the delete action.

Tip: Reviewing Native Integration runs once operational? When you have deployed a Native Integration to production, you can review the details of integration runs - for details, see Reviewing Integration Run Details.

Creating and Managing Notification Webhook Integrations

Creating Notification Webhook Integrations

To create a Notification Webhook Integration, you must first create a Notification rule based on a system Event. You can then link this Notification Rule to an Outgoing Webhook. When you make this link, it creates a Notification Webhook Integration:

Reviewing Integration Runs

When you have set up Native Integrations or Notification Webhook Integrations and deployed them to your production environment, you can use links to open integrations runs to review them.

Accessing Runs for Native Integrations

For Native Integrations for sending Bills out to your Account Receivable systems, links are provided on the Bill details pages of end-customer Accounts configured for the integration:

You can choose to View all runs or the Last integration run for the Account Bill. When you open an Integration run, you can then drill into a Run log to review the tasks performed for the run. If runs errors occurs this can be very helpful for troubleshooting. See Reviewing Bill Integration Runs for more details.

Accessing Runs for Notification Webhook Integrations

For Notification Webhook Integrations sending a payload out to a webhook when an Event occurs and triggers the Notification, links are provided on the Notification rule details page:

You can choose to View all runs or the Last run for the Notification. When you open an Integration run, you can then drill into a Run log to review the tasks performed for the run. If runs errors occurs this can be very helpful for troubleshooting. See Reviewing Notification Integration Runs for more details.

Integration Run Error Handling and Alerts

Once a Native Integration or Notification Webhook Integration is operational, checks are in place from the m3ter side to ensure some resilience for integration runs and to prevent runaway errors.

Native Integrations - Auto-Disabling

  • Auto-Disabling. If there have been 10 successive previous error Event responses to earlier attempts to run an integration, then the integration is automatically disabled and a Re-enable button will show for the Integration details. Please check the earlier error Events to resolve any issues preventing the integration from running before you re-enable the integration.

Notification Webhook Integrations - Auto-Failure

  • Auto-Failure. When a system Event occurs on which a Notification rule is based and triggers the Notification, four successive attempts are made to send the Notification payload out to the configured webhook. If all four attempts fail, then the integration is put into a failed state. Note that there's an exponential backoff built into this process - a wait of 2 seconds after the first failure before retry, then a wait of 4 seconds before retry, and so on.

Troubleshooting Disabled and Failed Integrations

Alerts and error Events are generated when an integration run fails and you can quickly check these to help with troubleshooting. Please check:

Next: Configuring Stripe Integrations


Additional Support

Login to the Support portal for additional help and to send questions to our Support team.