Connect to Payment Links accounts: 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
Section titled “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 receives every event for the connected merchant’s account: payment link events (created, updated, pending, failed, complete, expired and archived), and events about the account’s other objects, such as payments. Filter them on action and state, and let your users choose which events they act on and how. The payment link events are listed in Webhook events.
Requirements
Section titled “Requirements”Webhook URL requirements
Section titled “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
Section titled “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
Was this page helpful?
What went wrong?
Thanks for telling us.