Webhooks serve as real-time notifications for API events, providing updates as they happen. To receive webhook notifications, you must first register the receiving URL through E2.
To register the Webhook, the client should follow the steps:
1. Acesses web finance portal
2. Acess "Webhooks" menu and register webhooks types for your API
Best Practices for Sending URLs for Webhook Notification Registration:
1. Use HTTPS: Ensure secure communication.
2. Avoid IP Addresses: Prefer domain names for flexibility.
3. Provide Fully Qualified URLs: Include protocol and domain.
4. Include Endpoint Path: Specify the exact location for notifications.
5. Validate URL Format: Ensure correctness before registration.
6. Implement Authentication: Secure endpoints with authentication mechanisms.
7. Test Webhook Functionality: Verify proper functionality before deployment.
8. Monitor Delivery: Track webhook delivery and response status.
9. Handle Retry Logic: Implement retry strategies for failed deliveries.
10. Stay Informed: Keep updated on changes and updates.