Knowledge Base
  • Getting Started
    • Quick Start
    • Knowledge Base
    • Contact RoamingiQ
    • New Customer Onboarding
  • Network Equipment
    • Supported Access Points
    • Access Point Configuration Guides
      • What You'll Need
      • Ruckus Virtual Smart Zone 5.4
      • Ruckus Virtual Smart Zone 6.1
      • Ruckus One
      • Ruckus Unleashed
      • Cambium cnMaestro X
      • TP Link Omada Pro
      • Aruba Central
      • Cisco Meraki
    • Supported Routers
    • Router Configuration Guides
      • Mikrotik
  • Network Administrator Console
    • Network Administrator Console Introduction
    • Network Operator Settings
      • E-mail Templates
      • Terms and Conditions
      • Display Options
      • Network Administrators
      • Service Plans
      • FCC Broadband Labels
      • Keypools
      • Shopping Cart
        • Shopping Cart Payment Rules
      • Realpage
      • Webhooks
      • Network Operator Logs
      • Gateway Errors and Pending Changes
    • Creating a New Venue
      • Venue Details/General Information
      • Venue Details/Configuration Options
      • Overlapping Subscriptions
      • Add Venue Units
      • Add and Remove Service Plans to Venue
      • Add a Keypool to a Venue
      • Add Venue Administrators to a Venue
      • Add Equipment to a Venue
      • Configure Venue Shopping Cart
      • Connect a Venue to RealPage
      • Migrating a Venue to VAULT From Another Provider
    • Managing Your Subscribers
      • Add Subscribers to a Venue
      • View and Modify Subscriber Details
      • Ending a Subscription
      • Issuing a Refund or Credit
      • Messaging Subscribers
      • View Subscriber Bandwidth
      • View, Modify, and Test Subscriber Wi-Fi Passwords
      • View Subscriber Transaction History
      • View Subscriber Logs
      • View Subscriber Devices
      • View System Data
      • Permanently Delete a Subscriber Record
    • Managing Your Venues
      • View and Modify Venue Details
      • View and Modify Venue Units
      • Export Units
      • View Venue Bandwidth
      • View Venue Logs
      • View Venue Transaction History
      • Delete a Venue
    • How to Change Roles
    • SMS Sign Up
  • Venue Administrator Console
    • Venue Administrator Console Introduction
    • Venue Administrator Dashboard
      • Add Subscribers
      • Add Guests
      • Add Venue Administrators
      • Message Subscribers
      • Activity Summary
      • Service Status
      • Support Summary
      • Quick Search
      • Recent Service Activations
      • Renew or Confirm Upcoming Expirations
    • Managing Your Subscribers
      • View and Modify Subscriber Details
      • Ending a Subscription
      • View Subscriber Bandwidth
      • View Subscriber Transactions
      • Resend Activation E-mail
      • Export Subscribers
    • Support
  • Subscriber Console
    • Subscriber Console Introduction
    • Subscriber Account Activation
    • Subscriber Self-Sign Up
  • Developers
    • API Documentation
    • Sample Webhook Payloads
  • Property Management Group
Powered by GitBook
On this page
  • What Are Webhooks?
  • Why Would I Want to Use Webhooks?
  • How to Add a Webhook URL
  • What Webhooks Are Available ?

Was this helpful?

  1. Network Administrator Console
  2. Network Operator Settings

Webhooks

Here is a step-by-step guide on how to configure a webhook server in VAULT.

PreviousRealpageNextNetwork Operator Logs

Last updated 6 months ago

Was this helpful?

What Are Webhooks?

A webhook is an automated message or payload that is sent based on a unique trigger. You can think of it as a reverse API. Instead of a user or developer requesting information from an API in a pull fashion, a webhook sends information in a push fashion.

Why Would I Want to Use Webhooks?

Webhooks are a great way for Network Operators to capture data when an event occurs. For example, when an administrator , a webhook is sent to your webhook server with relevant information, including the administrator who issued it, the amount, and the subscriber it was issued to. This data can then be transformed and cataloged into your CRM or other database for record keeping.

How to Add a Webhook URL

What Webhooks Are Available ?

Webhooks for Venues

(VU1) VenueUnitAdded

(VU2) VenueUnitUpdated

(V7) KeyStart

(V8) KeyEnd

Webhooks for subscribers

(S1) LoginPasswordCreated

Webhooks for subscriptions

(SU1) SubscriptionSetupSuccess

(SU2) SubscriptionPlanUpdated

(SU3) SubscriptionVenueUnitUpdated

(SU4) SubscriptionPriceUpdated

(SU5) SubscriptionNextInvoiceAdjustment

(SU6) SubscriptionStartDateAdjustment

(SU7) SubscriptionEndDateAdjustment

Webhooks for Stripe-enabled subscriptions

(SUS2) StripePaymentSuccess

(SUS3) StripePaymentFailed

(SUS4) StripePaymentMethodUpdated

(SUS5) StripeChargeRefunded

Below is a list of available webhooks. You can view sample payloads for each webhook .

here
issues a refund