Webhooks

Webhooks allow your workflow platform to receive real-time notifications when payment link events occur. Instead of polling for updates, Shuttle will automatically send HTTP POST requests to your specified webhook URL whenever important events happen.

Overview

The webhook system consists of two main operations:

• Attach Webhook: Register a URL to receive event notifications for your connected instance
• Detach Webhook: Remove a previously registered webhook URL from your instance

Once attached, your webhook will receive notifications for all events across your connected merchant instance, including payment link events (creation, completion, failures, and status changes) as well as other events and shuttles. Leave it to the user to determine which webhooks they want to receive and how they want to handle them.

Requirements

Webhook URL Requirements

Your webhook endpoint must:

• Use HTTPS protocol (HTTP is not supported for security)
• Be publicly accessible from the internet
• Respond with HTTP status codes 200-299 to indicate successful receipt

API Reference

For complete implementation details, request/response schemas, and error codes:

• Attach Webhook - Register a webhook URL to receive event notifications
• Detach Webhook - Remove a previously registered webhook