Introduction

In today's digital landscape, automation and seamless integration are vital for efficient business operations.

This guide provides an in-depth overview of Webhook URLs within your partner settings, explaining their purpose, setup process, and practical applications.

Whether you're a developer, marketer, or business owner, understanding how to leverage webhooks can significantly enhance your automation workflows, improve customer engagement, and streamline operational tasks.

What Are Webhook URLs?

Webhook URLs are endpoints that allow your systems to receive real-time notifications about specific events. When an event occurs—such as a new user registration or a payment failure—the system sends an HTTP POST request to your designated webhook URL, delivering relevant data as a payload.

Key Features:

• Event-driven notifications: Receive instant updates on critical activities.

• Customizable: Use your own webhook URL to tailor responses.

• Supports multiple event types: From user registration to plan changes and payment issues.

• Integration-ready: Compatible with automation tools like Zapier, Integromat, and Public Connect.

Accessing and Setting Up Webhooks

Navigating to Partner API

• Partner API Link: Clicking this link directs you to the API page, where you can explore various APIs.

• Purpose: Automate processes such as checkout, cancellations, and failed payments.

Configuring Webhooks

1. Locate the Webhook Settings:

   • In your partner dashboard, find the "Set Web Hooks" option.

2. Input Your Webhook URL:

   • Enter your endpoint URL (e.g., Zapier webhook, Integromat, or custom server).

3. Select Event Types:

   • Choose from events like:

     • New User Registration

     • User Email Verified

     • Workspace Created or Deleted

     • Plan Changed or Renewed

     • Add-on Renewed

     • Overdue Payments

     • Insufficient Credit

Supported Webhook Types

Testing Webhook Events

Using the Sandbox Environment

• Purpose: Safely test webhook integrations without affecting live data.

• Steps:

  1. Create a Workspace:

     • Use your custom domain to set up a workspace.

  2. Send Workspace ID:

     • Copy the Workspace ID from settings.

     • Send it via support ticket email.

  3. Conversion to Sandbox:

     • Support team converts your workspace to a sandbox environment.

• Benefits:

  • No credit deduction during testing.

  • Safe environment to simulate real events.

Prerequisites for Testing

• Wallet Credit:

  • Ensure your partner account has at least $10-$20 in credit.

  • Zero balance will prevent sandbox requests from functioning.

• API Keys:

  • Obtain your API keys from the relevant documentation.

  • Follow tutorials to test event triggers.

Practical Applications of Webhook Events

Webhook notifications enable automation across various scenarios:

1. New User Registration

• Use Case: Automate onboarding emails.

• Implementation:

  • Trigger an email sequence welcoming new users.

  • Encourage subscription to plans.

2. Plan Renewal or Change

• Use Case: Send targeted offers or reminders.

• Implementation:

  • Notify users about upcoming renewals.

  • Promote upgrades or downgrades.

3. Overdue Payments & Insufficient Credits

• Use Case: Manage account credit issues.

• Implementation:

  • Send SMS or email alerts.

  • Prompt users to add funds to continue services.

4. Workspace Management

• Use Case: Track workspace creation or deletion.

• Implementation:

  • Automate resource provisioning.

  • Maintain accurate user data.

How to Connect and Automate

Step-by-Step Workflow

1. Set Up Your Webhook URL:

   • Use platforms like Zapier, Integromat, or your custom server.

2. Configure Event Triggers:

   • Select relevant events in your partner dashboard.

3. Test the Webhook:

   • Use the provided tutorials (Lesson 8 & 9) to verify event reception.

4. Create Automation Flows:

   • Map incoming data to actions like emails, SMS, or CRM updates.

5. Monitor and Adjust:

   • Regularly check webhook logs for errors.

   • Fine-tune payload handling as needed.

Summary Table: Key Concepts

Final Thoughts

Webhooks are powerful tools that enable real-time communication between your platform and external systems. Proper setup and testing ensure reliable automation, leading to improved user engagement and operational efficiency. Remember:

• Always test in a sandbox environment before going live.

• Maintain sufficient wallet credit for seamless testing.

• Use automation platforms to simplify webhook integration.

• Regularly monitor webhook activity for errors or missed events.

By mastering webhook configurations, you unlock a new level of automation that can save time, reduce manual effort, and enhance your customer experience.