Flavours API Documentation
  1. Error Webhook
Flavours API Documentation
  • Readme
  • Developer Guide
  • Authorization
  • Includables
  • Pagination
  • Sorting
  • Retrieve Market Information
  • Retrieve Branch Information
  • Me
    • Overview
    • Detail
      GET
  • Branches
    • Overview
    • List
      GET
    • Detail
      GET
    • Create
      POST
    • Update
      POST
    • Delete
      DELETE
  • Orders
    • Overview
    • List
      GET
    • Detail
      GET
    • Create
      POST
    • Calculate
      POST
    • Checkout
      POST
    • Update
      POST
    • Sync
      POST
  • Customers
    • Overview
    • List
    • Detail
    • Create
    • Update
  • Products
    • Overview
    • List
    • Detail
    • Create
    • Update
    • Delete
  • Product Categories
    • Overview
    • List
    • Detail
  • Discounts
    • Overview
    • List
    • Detail
    • Verify
  • Payment Methods
    • Overview
    • List
    • Detail
  • Table
    • Overview
    • List
    • Detail
    • Create
    • Update
    • Delete
  • Printer
  • Webhook
    • Orders Webhooks
      • Webhook Events
      • Payload
    • Product Webhooks
      • Webhook Events
      • Payload
    • Loyalty Webhooks
      • Promotional Coupon
    • Customers Webhooks
      • Webhook Events
      • Payload
    • Error Webhook
      • Stay Alert to Connectivity Issues
    • Third-Party
      • Ballurh
        • Install Ballurh
      • Loyapro
        • Loyalty
          • Check Reward
          • Redeem Reward
      • Bonat
        • Check Reward
        • Redeem Reward
      • Fai
        • Register Entity
  1. Error Webhook

Stay Alert to Connectivity Issues

Stay Alert to Connectivity Issues: The Error Webhook#

Flavours offers the error webhook to keep you informed about potential communication challenges between your integration and the platform.

Trigger:#

Flavours encounters three consecutive failed attempts to deliver a webhook notification to your designated endpoint.

Notification:#

Flavours sends a POST request to your error webhook endpoint, specifically designed to handle delivery errors.
The request contains the following information:
{
    "code": "intger",     // An error code indicating the nature of the failure.
    "endpoint": "string", // The URL of the webhook that failed to receive notifications.
    "message": ""         // A human-readable description of the error.
}

Purpose#

Alerts you to connectivity issues : Prompts you to investigate and rectify any problems that might be hindering webhook delivery.
Prevents data loss : Ensures you don't miss out on crucial events and updates from RETM.
Facilitates troubleshooting : Provides valuable information to aid in diagnosing and resolving the root cause of delivery failures.

Handling Recommendations:#

Log errors : Meticulously record error webhook notifications for analysis and troubleshooting.
Investigate causes : Analyze logs and error details to identify potential issues, such as network problems, endpoint configuration errors, or application downtime.
Implement corrective measures : Take steps to address identified issues, such as:
Ensuring endpoint availability and responsiveness.
Resolving network connectivity problems.
Optimizing application performance to handle webhooks efficiently.
Implementing retry mechanisms within your integration to handle temporary delivery failures gracefully.

Best Practices:#

Prioritize error webhook handling : Dedicate resources to promptly address error notifications to maintain reliable communication with Flavours.
Conduct regular health checks : Proactively monitor webhook delivery success rates and endpoint availability.
Incorporate testing : Thoroughly test webhook integration during development and maintenance phases.
By effectively utilizing the error webhook, you'll maintain a robust and reliable connection with Flavours, ensuring data integrity and optimal functionality within your integration.
Previous
Payload
Next
Install Ballurh
Built with