Option Actions Callback

This article helps you understand how the webhook callback is created when Item/Option - actions API is called

Written By Ops UrbanPiper (Collaborator)

Updated at May 4th, 2021

API Document Reference — https://api-ordering-docs.urbanpiper.com/#option-actions-callback


  1. What is the purpose of this Callback?
    - This webhook helps in keeping the reference of the response received for the API call made for Options to Item/Option - actions API. Once the response is received from the aggregators, the same will be sent over through this webhook callback.

  2. Why is it important to consume this webhook?
    - Once the API request is made to UP, UP will in turn make a request to aggregators to perform the action. Based on the response received from the aggregators, the same will have relied back on to the POS partners through the webhook. There might have scenarios where the request gets failed at aggregators end, it is always best practice to wait for the callback and accordingly update the same in POS partner application.

  3. How long it will take to receive the callback response?
    - As the API request is made to aggregators directly via UrbanPiper, UP waits for the response received from the aggregators and accordingly triggers the callback to the POS endpoint. No time-bound guarantees are available as of now.

  4. Does this callback return the "status" of the request?
    - Yes.

  5. How the callbacks are captured and validated?
    - Based on how many platforms the options are associated with, those many individual callbacks are received. Based on the "reference_id" received in the API request and callbacks, the 3rd party system can very well track the data.

Was this article helpful?