Learn how to set up and configure webhooks for your Notch Pay account
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.
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.
Create a Webhook Endpoint
Set up an endpoint on your server that can receive HTTP POST requests from Notch Pay.
Register Your Endpoint
Add your webhook URL to your Notch Pay account and select which events you want to receive.
Implement Signature Verification
Verify that incoming webhook requests are actually from Notch Pay by checking the signature.
Process Webhook Events
Handle the different types of events and update your systems accordingly.
Test Your Implementation
Use the Notch Pay dashboard to send test events to your webhook endpoint.
Automatically update order status when a payment is completed, failed, or refunded. Trigger fulfillment processes and notify customers about their order status.
Send confirmation emails, SMS notifications, or in-app messages to customers when their payments are processed or transfers are completed.
Update your inventory systems automatically when products are purchased. Trigger reordering processes when stock levels fall below thresholds.
Track payment success rates, monitor failed payments, and analyze customer payment patterns. Log events for audit trails and compliance reporting.
Your webhook endpoint should:
https://example.com/webhooks/notchpay
)https://example.com/webhooks/notchpay
)For more details, see the Webhooks API Reference.
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
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
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 |
Test in the Dashboard
Use the “Test” button in your Notch Pay dashboard to send test events to your webhook endpoint.
Test Locally with Tunneling
For local development, use tools like ngrok to expose your local server to the internet:
Use the generated URL (e.g., https://abc123.ngrok.io/webhooks/notchpay
) as your webhook endpoint.
Check Webhook Logs
Monitor your webhook delivery logs in the Notch Pay dashboard to ensure events are being delivered successfully.
Return a 200 response as soon as possible, then process the webhook asynchronously to avoid timeouts.
Always verify webhook signatures to ensure they come from Notch Pay.
Design your webhook handler to be idempotent, as the same event might be delivered multiple times.
Log all webhook events for debugging and auditing purposes.
Be prepared for Notch Pay to retry failed webhook deliveries with exponential backoff.
Monitor your webhook endpoint’s performance to ensure it can handle the volume of events.
Explore the complete Webhooks API documentation
Learn more about webhook signature verification
Explore the complete API documentation
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.
Explore the complete Webhooks API reference documentation for detailed information about endpoints and parameters.
View API Reference
Our SDKs provide built-in support for webhook signature verification and event handling.
Explore SDKs
Having issues with your webhooks? Check our troubleshooting guide for common problems and solutions.
Troubleshooting Guide