Webhooks

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

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 issues a refund, 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 ?

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

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