🪝Webhooks

Webhooks section allows you to view the existing as well as create new Webhooks. Let us take a look at how this is done.

Boomerangme > Left-Hand Menu > Settings

How to add a webhook

1. Follow the above-mentioned workflow to land on the Settings screen.

2. From the tabs listed at the top, click Webhooks. Doing so takes you to the Webhooks screen.

1. To create a webhook, click the Add webhook button. This opens the Add webhook popup.

1. Here, enter the URL in the field displayed at the top of the popup.

1. Mark the checkbox for the event(s) for which you want to trigger the webhook.

1. As the selections are made, mark the status as enabled using the Status toggle button. Once the required selections are made, click the Add Webhook button.

1. This adds the webhook and displays it in the Webhooks list. Click on the webhook name and you will be able to change it.

1. Be sure to save after making changes.

Description of webhook events

🧍‍♂️ Cards & customers (card holders)

CardBalanceUpdatedEvent Triggered when the card balance changes (e.g., bonuses, cashback added or deducted).

CardExpiredEvent Triggered when a customer's card reaches its expiration date.

CardInstalledEvent Triggered when a card is added to the customer’s wallet (Apple Wallet / Google Wallet / PWA).

CardIssuedEvent Triggered when a new card is issued to a customer.

CardRemovedEvent Triggered when a card is removed by the customer or administrator. The card status changes from “installed” to “deleted”.

CardScannedEvent Triggered when the card is scanned by a scanner.

CustomerCreatedEvent Triggered when a new customer is created (either via card issuance or manual addition to the database).

CustomerReferralCreatedEvent Triggered when a referral is added (at the time of card issue via referral link).

CustomerSegmentLinkedEvent Triggered when a customer is moved to a new RFM segment based on their activity/value.

FeedbackCreatedEvent Triggered when a customer leaves feedback (either by selecting a star rating or writing a comment).

🏢 Subaccounts & Managers

CompanyCreatedEvent Triggered when a new subaccount is registered.

CompanyRemovedEvent Triggered when a subaccount is deleted.

ManagerCreatedEvent Triggered when a new manager is created.

ManagerRemovedEvent Triggered when a manager is removed.

💸 Payments & Subscriptions

PaymentCompletedSuccessfulEvent Triggered when a subscription payment is successfully completed by a subaccount.

PaymentCompletedFailedEvent Triggered when a subscription payment attempt fails.

PaymentRefundedEvent Triggered when a payment is refunded to a subaccount.

RecurrentPaymentCompletedFailedEvent Triggered when a recurring subscription payment attempt fails.

📅 Subscription/Tariff Events

TariffActivationDateChangedEvent Triggered when the tariff start date is updated for a subaccount.

TariffExpiredPaymentEvent Triggered when a subaccount’s subscription expires due to non-payment.

TariffFiveDaysBeforePaymentEvent Notification 5 days before the subscription is charged, including before the end of the trial period (for subaccounts).

TariffThreeDaysBeforePaymentEvent Notification 3 days before the subscription is charged, including before the end of the trial period (for subaccounts). .

TariffOneDayBeforePaymentEvent Notification 1 days before the subscription is charged, including before the end of the trial period (for subaccounts). .

TariffPaymentCreatedEvent Triggered when a new subscription payment is created for a subaccount.

TariffPaymentDayEvent Triggered on the actual payment date.

🧾 Marketing Events (Subscription Webhooks)

webhook_MarketingFirstTariffPayment Triggered after the first successful tariff payment by a subaccount.

webhook_MarketingRepeatedTariffPayment Triggered after the second or subsequent tariff payment by a subaccount.

webhook_MarketingTariffPaymentFailed Triggered when a tariff payment attempt fails.

webhook_MarketingTrialStarted Triggered when a subaccount starts a trial period.

webhook_MarketingSubscriptionCancelled Triggered when a subaccount cancels their subscription.

webhook_MarketingPaymentCardLinked Triggered when a subaccount adds a payment card for their subscription.

webhook_MarketingUserDataChanged Triggered when a subaccount updates their personal data (e.g., name, email).

📦 Templates

UserTemplateActivatedEvent Triggered when a card template is activated in an account or subaccount.

UserTemplateCreatedEvent Triggered when a new card template is created.

UserTemplateDeactivatedEvent Triggered when a template is deactivated, for example when a subaccount plan is downgraded.

UserTemplateRemovedEvent Triggered when a template is deleted from the account/subaccount.

UserTemplateUpdatedEvent Triggered when changes are made to the template in an account (not for a subaccount).