# Webhooks

### 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](/network-administrator-console/managing-your-subscribers/issuing-a-refund-or-credit.md), 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

{% embed url="<https://scribehow.com/shared/Add_a_Webhook_URL_in_VAULT__mnecwHWXTpKL_NIILEZYjA>" %}

### What Webhooks Are Available ?

Below is a list of available webhooks. You can view sample payloads for each webhook [here](/developers/sample-webhook-payloads.md).

#### Webhooks for Venues

(VU1) VenueUnitAdded

(VU2) VenueUnitUpdated

(V7) KeyStart

(V8) KeyEnd

#### Webhooks for subscribers

(S1) LoginPasswordCreated&#x20;

#### Webhooks for subscriptions

(SU1) SubscriptionSetupSuccess&#x20;

(SU2) SubscriptionPlanUpdated&#x20;

(SU3) SubscriptionVenueUnitUpdated&#x20;

(SU4) SubscriptionPriceUpdated&#x20;

(SU5) SubscriptionNextInvoiceAdjustment&#x20;

(SU6) SubscriptionStartDateAdjustment&#x20;

(SU7) SubscriptionEndDateAdjustment

#### Webhooks for Stripe-enabled subscriptions

(SUS2) StripePaymentSuccess&#x20;

(SUS3) StripePaymentFailed&#x20;

(SUS4) StripePaymentMethodUpdated&#x20;

(SUS5) StripeChargeRefunded


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.roamingiq.com/network-administrator-console/network-operator-settings/webhooks.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.