Configuring up a Webhook enables your application to receive live event notifications from Sandbox Console, allowing it to act on events in real-time.

What You’ll Need

• A Webhook URL / Callback URL: The endpoint where live event data will be sent.
• Secret Key (optional but recommended): For validating the authenticity of requests from Sandbox.
• An Alert Email: An email address to receive notifications in case of Webhook failures.

Steps to Configure a Webhook

1. Log in to Console: Access your account by logging into the Console with your credentials

2. Navigate to Webhooks Settings: Go to Settings in the top-right corner and click on Webhooks from the sidebar.

3. Add Webhook Details:

• Webhook URL: Enter the endpoint URL where your application will receive events. Ensure the URL:
  • Is accessible over the internet.
  • Supports HTTP POST requests to accept webhook payloads.
• Secret Key (Optional): Add a secret key to verify incoming webhook requests. This ensures that only requests originating from Sandbox are processed by your system.

4. Enable failure alerts: Provide an email address to receive notifications in case of Webhook delivery failures. This step is optional but helps in monitoring reliability.

5. Select Category and API:

• Select a Category, such as TDS Compliance or GST Analytics to view relevant APIs.
• Choose the specific API for which you want to enable events, such as Prepare TDS Return or Reconcile GSTR-2B.

6. Save

• Review the details and click Save to activate the Webhook. Your application will begin receiving live events for the configured API.

Need Help?

If you encounter issues while configuring your Webhook, raise a ticket.