Acknowledge quickly with a success status
Terminal49 expects your endpoint to return a success status (200, 201, 202, or 204). Acknowledge quickly โ but only after you have durably accepted the event. Persist the raw payload or push it onto a queue first, then return the response and process the event asynchronously.
Handle retries and duplicate deliveries
Terminal49 retries failed deliveries, which means your endpoint may receive the same notification more than once. Design your consumer to be idempotent. Every webhook notification has a uniqueid in data.id. Use it to deduplicate:
Verify the webhook source
Terminal49 publishes the IP addresses that webhook notifications originate from. Use the List Webhook IPs endpoint to fetch the current list and validate incoming requests:Cache the IP list and refresh it periodically (e.g., daily). The list rarely changes, but checking the endpoint ensures you stay current.
Monitor delivery status
Use the Webhook Notifications API to check delivery status and catch any notifications your endpoint may have missed:delivery_status attribute reports the delivery state (pending, succeeded, or failed). Page through recent notifications and review the ones marked failed regularly to identify issues with your endpoint before they cause data gaps.
Test with the Trigger endpoint
Use the Trigger Webhook endpoint to send a one-time sample webhook notification to an HTTPS URL. This is useful when you want to validate your signature verification, parsing, queueing, and event routing before subscribing a production webhook.secret, Terminal49 signs the test request with the same X-T49-Webhook-Signature header used by real webhook deliveries.
Handle downtime gracefully
If your endpoint goes down, Terminal49 retries failed deliveries. When your endpoint recovers:- Use the Webhook Notifications API to list recent notifications and identify the ones with
delivery_status: failed. - Re-fetch the current state of the affected shipments and containers from the REST API. Webhook notifications cannot be replayed โ the Trigger Webhook endpoint only sends a one-time sample payload for testing.
- For longer outages, list recent shipments via the API to catch up on any missed state changes.
Keep your webhook active
Terminal49 may deactivate a webhook after repeated delivery failures. Check your webhookโsactive status periodically:
active: true.
Summary checklist
- Return a success status (
200,201,202, or204) after durably accepting the event, then process asynchronously - Deduplicate using the notification
id - Validate the source IP against the webhook IPs list
- Monitor failed notifications
- Subscribe only to the events you need
- Log raw payloads for debugging
Related
- Setting up webhooks โ create and configure endpoints
- Event catalog โ all available events
- Webhook payloads โ notification envelope and included resources
- Webhook API Reference โ CRUD operations for webhooks