Integrate with Fusebill's API to Automate Invoices, Payments and Collections

Dive into our comprehensive Documentation, API Reference and Tutorials to start working with the Fusebill Subscription Billing platform. Connect easily with Fusebill support to help get your integrations to market as quickly and as seamlessly as possible.

Get Started

Overview

Using Webhooks

Overview

Webhooks allow you to collect information about events as they happen in near real-time. Provide a URL, select the events on your customers that you would like us to notify you about, and we'll send them to you as the events take place.

To test Webhooks before setting up scripts, the Request Bin tool is an excellent utility that helps you see data come across as various events happen in our system.

When Should I Be Using Webhooks?

Let’s start with the basics. The obvious case for webhooks is when you need to act on specific events. At Fusebill, this includes actions like a customer creation, modifying a subscription, etc. If you would otherwise have to poll for data, you should be using webhooks.

How Should I Handle Webhook Requests?

There’s no official spec for webhooks, so the way they’re served and managed is up to the originating service. At Fusebill we’ve identified two key issues:

  • Ensuring delivery/Detecting failure
  • Protecting our system

To this end, we’ve implemented a 2-second timeout period and allow for 3 retries. We wait 2 seconds for a response to each request, and if there isn’t one or we get an error, we retry the connection. The retries will be sent 1-minute, 2-minutes, and 3-minutes after the original failure.

If you’re receiving a Fusebill webhook, the most important thing to do is respond quickly. There have been historical occurrences of apps that do lengthy processing when they receive a webhook, this triggers the timeout.

Ensure that your web server is returning a 2xx response to our servers. Any other response type will result in our server retrying a POST until we receive a 2xx response or the maximum time has expired. All events are retried at increasing intervals after the event occurs. Make sure you are not blocking our IPs that are trying to POST to your server.

Manage concurrency

When a user makes a number of changes in rapid succession, your app is likely to receive multiple notifications for the same user at roughly the same time. If you're not careful about how you manage concurrency, your app can end up processing the same changes for the same user more than once.

For some applications, this is not a serious issue. Work that can be repeated without changing the outcome is called idempotent. If your app's actions are always idempotent, you don't need to worry much about concurrency.

Resilient Parsing

We do not guarantee the order of properties in our Webhook Payloads.

Note that new fields can be added at any time to our Webhook Payloads. Code that is used to parse webhooks should be resilient to these changes.

You will want to configure webhooks in Fusebill Admin

Event Source

Fusebill webhooks support a field to define where the source of call originated from.

Current event sources:

  • FusebillUI
  • API
  • FusebillReg
  • FusebillSSP
  • Salesforce
  • SubscriptionPlatform
  • System
  • {Custom Source}

When making calls via the API, you can enter a custom event source. To do this add a header to the API call called x-audit-source you can then specify the source of the call.

Example

x-audit-source:"test"

Or

private HttpClient GetHttpClient(string acceptType = "application/json", int timeout = 60)
        {
            var httpClient = new HttpClient();
            httpClient.DefaultRequestHeaders.Authorization = "Basic" + ApiKey;
            httpClient.DefaultRequestHeaders.Add("Accept", acceptType);
            httpClient.DefaultRequestHeaders.Add("x-audit-source", _auditSource);
        }

Updated 9 months ago

Overview


Using Webhooks

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.