Skip to main content

Notifier Webhook Endpoint​

What is the Notifier Webhook Endpoint?​

A Notifier Webhook Endpoint is a designated URL used to receive automated notifications or updates asynchronously from a system. In the context of API integrations, it serves as a callback mechanism where the Upstox API service sends specific data, such as access tokens, after an event is triggered.

Key Features of a Notifier Webhook Endpoint:​

  • Purpose: Acts as the recipient for system-generated notifications, such as the delivery of an access_token etc.
  • Configuration: Typically specified during the app generation process.
  • Communication: Operates as a POST API where the Upstox API system sends the data.
  • Response: The endpoint should acknowledge receipt by returning either a plain string or a JSON object.
  • Authentication: The endpoint should not require authentication.

In summary, the Notifier Webhook Endpoint facilitates automated communication between systems, ensuring real-time data transfer without manual intervention.

Configure Notifier Webhook Endpoint during App Generation​

Follow these steps to set up a notifier webhook endpoint for an API app:

  1. My Apps Section: Visit the Upstox My Apps page to view the active my apps section. Here, you can manage your app and token.

    My Apps Dashboard

  2. Setup Notifier Webhook Endpoint:

    • Click the New App button to open the new application form. This form allows you to provide details for your new app.

    • To update an existing app, Click the Edit button to open the application form containing existing app details.

    • In addition to the fields for the redirect URL and postback URL, a new optional field called Notifier Webhook Endpoint has been added.

      App Form

  3. Complete the App Form: Fill in the required fields in the form to define your app. After entering the information, click Continue to create/update an app. Filled App Form

NOTE
  • We recommend that access token initiators advise their customers to configure the initiator's POST API as the notifier webhook endpoint. This ensures that initiators receive Upstox API events related to Upstox API actions asynchronously.