Avibra Integration API
1.0.1
  • 1.0.2
  • 1.0.1
Home
Home
1.0.1
  • 1.0.2
  • 1.0.1
1.0.1
  • 1.0.2
  • 1.0.1
  1. Avibra
  • Avibra
    • Embedded UX/UI
    • Security
      • Authentication API
      • LinkToken API
    • Benefits
      • Get Benefits With Status
    • User Management
      • Create User
      • Update User
      • Cancel User
      • Prefil User
    • Webhook
      • Webhook API (provided by partner)
    • Export Data
      • Open API Spec
      • API Coverages
  • Schemas
    • Schemas
      • eventInfo
      • userInfo
      • addressInfo
      • benefitwithstatusInfo
      • benefitwithstatusInfos
      • errorInfo
      • updateuserInfo
      • linktokenInfo
      • linktokenesponseInfo
      • accesstokenInfo
      • getbenefitInfo
      • offerInfo
      • offerInfos
      • currentofferdetailsInfo
      • offers
      • prefillInfo
Home
Home
1.0.1
  • 1.0.2
  • 1.0.1
1.0.1
  • 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_receivedThis event is send to partner after receipt of Prefill User Request
enrollment_successfulThis event is send to partner after user account is created.
offer_activation_successfulThis event is send to partner after offer is activated for user.
offer_upgrade_successfulThis event is send to partner after offer upgrade was successful. This applies to partner with multiple offer setup.
offer_downgrade_successfulThis event is send to partner after offer downgrade was successful. This applies to partner with multiple offer setup.
offer_removal_successfulThis event is send to partner after offer removal was successful or account is deleted
offer_error_processingThis event is send to partner if there is an error setting up user offers / Cancel User offers.
membership_renewed_successfullyThis event is send to partner when membership is renewed successfully.
membership_renewal_pendingThis event is send to partner when membership renewal is pending.
membership_deactivatedThis event is send to partner when membership is deactivated
membership_reactivatedThis event is send to partner when membership is reactivated
membership_upgraded_sucessfullyThis event is send to partner when the user upgrades to essentials
membership_downgraded_successfullyThis event is send to partner when the user downgrades to core
Modified at 2025-05-16 15:54:41
Previous
Prefil User
Next
Webhook API (provided by partner)