Webhook Setup
Real-time Event Notifications
Learn how to set up webhooks to receive instant notifications when events occur in your Notch Pay account, enabling you to automate your business processes and provide a better customer experience.
What are Webhooks?
Webhooks are HTTP callbacks that notify your application when events happen in your Notch Pay account. Instead of your application constantly polling the Notch Pay API for updates, webhooks push events to your application as they happen.
Think of webhooks as a “phone call” from Notch Pay to your application, rather than your application repeatedly “calling” Notch Pay to check for updates.
Why Use Webhooks?
- Real-time updates - Get notified immediately when events occur
- Reduced API calls - No need to constantly poll for updates
- Automation - Trigger workflows automatically
- Better user experience - Update your UI in real-time
Implementation Overview
Create a Webhook Endpoint
Register Your Endpoint
Implement Signature Verification
Process Webhook Events
Test Your Implementation
Common Use Cases
Order Management
Customer Communications
Inventory Management
Analytics & Reporting
Setting Up Your Webhook Endpoint
Your webhook endpoint should:- Accept HTTP POST requests
- Parse JSON request bodies
- Respond with a 2xx status code (preferably 200 OK)
- Process the webhook data asynchronously if needed
Registering Your Webhook
- Log in to your Notch Pay Business suite
- Navigate to Settings > Webhooks
- Click “Add Endpoint”
- Enter your webhook URL (e.g.,
https://example.com/webhooks/notchpay
) - Select the events you want to receive
- Click “Save” to create the webhook
Key Webhook Events
Payment Events
Payment Events
Event | Description |
---|---|
payment.created | Triggered when a payment is created |
payment.complete | Triggered when a payment is successfully completed |
payment.failed | Triggered when a payment fails |
payment.canceled | Triggered when a payment is canceled |
payment.expired | Triggered when a payment expires |
Transfer Events
Transfer Events
Event | Description |
---|---|
transfer.created | Triggered when a transfer is created |
transfer.complete | Triggered when a transfer is successfully completed |
transfer.failed | Triggered when a transfer fails |
Customer Events
Customer Events
Event | Description |
---|---|
customer.created | Triggered when a customer is created |
customer.updated | Triggered when a customer is updated |
customer.deleted | Triggered when a customer is deleted |
Securing Your Webhooks
Testing Your Implementation
Test in the Dashboard
Test Locally with Tunneling
https://abc123.ngrok.io/webhooks/notchpay
) as your webhook endpoint.Check Webhook Logs
Best Practices
Respond Quickly
Verify Signatures
Handle Duplicates
Implement Logging
Handle Retries
Monitor Performance
Next Steps
Webhooks API Reference
Webhook Verification
API Reference
Secure Your Webhooks
Now that you’ve set up your webhook endpoint, it’s important to secure it by verifying webhook signatures. This ensures that webhook events are actually coming from Notch Pay and not from a malicious source.
API Reference
Explore the complete Webhooks API reference documentation for detailed information about endpoints and parameters.
View API ReferenceSDK Integration
Our SDKs provide built-in support for webhook signature verification and event handling.
Explore SDKsTroubleshooting
Having issues with your webhooks? Check our troubleshooting guide for common problems and solutions.
Troubleshooting Guide