Skip to main content
Webhooks let you receive real-time HTTP POST notifications when events occur in Eaze Customs. Instead of polling the API for updates, Eaze Customs pushes notifications directly to your application server.

​
How webhooks work

When an event occurs (for example, when a declaration is cleared by customs), Eaze Customs generates an event payload. The system then sends an HTTP POST request to your configured webhook URL with the event type and details. To receive webhook events, your server must expose a public HTTP endpoint that is capable of receiving POST requests with a JSON body.

​
Configure a webhook

You can configure webhook subscriptions through the Eaze Customs dashboard or programmatically via the API. To configure a webhook in the dashboard:
  1. Navigate to Company Details under the Global Modules menu.
  2. Select the API Keys & Webhooks tab.
  3. Click Add Webhook.
  4. Enter the URL of your endpoint.
  5. Provide an optional signature key for verification.
  6. Click Save.

​
Security and signature verification

To ensure that webhook payloads are authentic and sent by Eaze Customs, you should verify the signature. Eaze Customs includes the pre-shared signature key in the Eaze-Signature header of every webhook request.

​
Verify the signature

When configuring your webhook, you can specify a secret string as your signature key. When a webhook is sent, Eaze Customs passes this key in the header: 
Eaze-Signature: your_configured_signature_key
Verify that the header value in the incoming request matches the signature key you configured. If the values do not match, reject the request.
For additional security, you should also verify the source IP address of incoming requests to ensure they originate from Eaze Customs servers.

​
Retry policy

If your server returns a non-2xx status code or times out, Eaze Customs logs the failure and attempts to deliver the event again.
  • Webhook delivery attempts are retried automatically.
  • Each attempt logs the HTTP status code and response body for debugging in the API Keys & Webhooks dashboard.
  • You can also manually retry failed webhook events directly from the UI on the API Keys & Webhooks tab in Company Details.