Avibra Integration API
1.0.2
  • 1.0.2
  • 1.0.1
Home
Home
1.0.2
  • 1.0.2
  • 1.0.1
1.0.2
  • 1.0.2
  • 1.0.1
  1. Avibra
  • Avibra
    • Change Log
    • Embedded UX/UI
    • Security
      • Authentication API
      • LinkToken API
    • Benefits
      • Get Benefits With Status
    • User Management
      • Create User
      • Update User
      • Cancel User
      • Prefil User
      • Upgrade/Downgrade User
    • Webhook
      • Webhook API (provided by partner)
    • Export Data
      • Open API Spec
  • Schemas
    • Schemas
      • eventInfo
      • userInfo
      • addressInfo
      • benefitwithstatusInfo
      • benefitwithstatusInfos
      • errorInfo
      • updateuserInfo
      • linktokenInfo
      • linktokenesponseInfo
      • accesstokenInfo
      • getbenefitInfo
      • userofferInfos
      • offerInfo
      • offerInfos
      • currentofferdetailsInfo
      • offers
      • prefillInfo
      • moredetail
      • moredetails
Home
Home
1.0.2
  • 1.0.2
  • 1.0.1
1.0.2
  • 1.0.2
  • 1.0.1
  1. Avibra

Webhook

Avibra Notifications enables partners to receive various lifecycle event notifications. Partners have the flexibility to select which events they wish to subscribe to.
The API endpoint will be provided by the partner and must adhere to the specified response object signature outlined below. Partners can choose to authenticate using basic authentication credentials or rely on IP address-based security without credentials.

Partner should expect event notification in below format-#

eventInfo

Available Events#

Event NameDescription
enrollment_request_receivednotifies receipt of enrollment request to partner.
enrollment_successfulnotifies after enrollment is successful.
offer_activation_successfulnotifies offer is activated for user.
offer_upgrade_successfulnotifies offer upgrade was successful.
user_benefits_pendingswapWhen a user selects benefit(s) for swapping in the Avibra app, an event is sent to the partner to indicate that a benefit has been selected for swapping but has not yet been swapped.
user_benefits_swappedWhen a user's benefit(s) are swapped, an event is sent to the partner to indicate that the benefit swap has been completed.
offer_downgrade_successfulnotifies offer downgrade was successful.
offer_removal_successfulnotifies offer removal was successful.
offer_error_processingnotifies when error processing offers.
membership_renewed_successfullynotifies when membership is renewed successfully.
membership_renewal_pendingnotifies when membership renewal is pending.
membership_deactivatednotifies when membership is deactivated
membership_reactivatednotifies when membership is reactivated
membership_upgraded_sucessfullynotifies when the user upgrades to essentials
membership_downgraded_successfullynotifies when the user downgrades to core
unknown_offernotifies when offer in offer api is unknown
Modified at 2025-05-23 15:10:14
Previous
Upgrade/Downgrade User
Next
Webhook API (provided by partner)