mycover.ai
  • Home
  • Distributor
  • 🚀Getting Started
    • Quickstart
    • Environments
    • Authentication
    • Testing
    • Errors
    • Go Live Checklist
    • FAQs
  • 🔌Libraries & SDKs
    • Javascript
    • Vue 2
    • Vue 3
    • React
    • Flutter
    • Android
    • React Native
    • iOS
  • 📦api reference
    • Products
      • 🚘Auto
        • Aiico
        • Leadway
        • MyCoverGenius
        • Sovereign Trust
        • Coronation
        • Tangerine
        • Sanlam
      • ♥️Health
        • Hygeia
          • Hyprime Insurance
          • Hybasic Insurance
        • Bastion
          • Bastion Health
          • MediSure
        • Malaria Cover
      • 💞Personal Accident Cover
        • Aiico
        • Leadway
        • Sanlam
      • 🏠Content (Home/Office)
        • Aiico
        • Coronation
        • Sanlam
      • ✈️Travel
        • Allianz
        • Aiico
      • 💵Life Insurance
        • Credit Life
        • SME Flex
        • Flex Life
      • 🚚Goods In Transit
        • Goods In Transit (GIT)
        • Goods In Transit (GIT) On-demand
      • 💻Gadget
        • Sovereign Trust Insurance
        • Coronation
        • Tangerine
      • 🛳️Marine Insurance ✨
        • MyCoverGenius Import Marine Cover
        • Marine Cover
    • Policies
    • Claims
      • Credit Life
    • Wallet
    • Transactions
    • Customers
    • Auxiliary
      • Products
        • Bulk Purchase
  • 🧳Services
    • Webhooks
      • Validation
      • Purchase Webhook
      • Renewal Webhook
    • Messaging
Powered by GitBook
On this page
  • Event: renewal.successful
  • Webhook Parameters And Description

Was this helpful?

  1. Services
  2. Webhooks

Renewal Webhook

Event: renewal.successful

This webhook event is triggered when a client initiates a policy renewal, and the transaction is successfully completed.

{
    "event": "purchase.successful",
    "data": {
      "id": "e431432e-3daa-11ee-be56-0242ac120002",
      "amount": 5000,
      "status": "successful",
      "reference": "BUY-PSKUEVZSSXVJRPQX",
      "customer": {
        "id": "db0c25ae0-3dab-11ee-be56-0242ac120002",
        "first_name": "Jack",
        "last_name": "Olu",
        "email": "jackolu200@gmail.com",
        "phone": "+2349162753630",
      },
      "product_id": "280798d6-3dac-11ee-be56-0242ac120002",
      "created_at": "2023-08-18T09:47:22.008Z",
      "updated_at": "2023-08-18T09:47:22.008Z",
      "policy_expiry_date": "2023-09-18T09:47:22.008Z",
    },
}

Webhook Parameters And Description

Here are the webhook parameters and their corresponding descriptions:

Data
Description

data.id

The unique ID generated for the purchase

data.amount

The amount paid for the product

data.status

The status of the transaction which is either successful or failed

data.reference

The unique generated reference code bound to the policy

data.customer.id

The unique ID generated for the customer

data.first_name

The customer's first name

data.last_name

The customer's last name

data.email

The customer's email

data.phone

The customer's phone number

data.product_id

The unique ID of the product purchased

data.created_at

The timestamp indicating when the transaction was created

data.updated_at

The timestamp indicating the last update time of the transaction.

data.policy_expiry_date

The new date indicating when the policy would expire

PreviousPurchase WebhookNextMessaging

Last updated 1 year ago

Was this helpful?

🧳