webhooks

Purpose

At Atomix, we use webhooks to notify our clients about important events or updates in our system. For example, when an order is shipped, we send a webhook notification to the client's specified shipment endpoint with the shipment details.

By using webhooks, we provide our clients with timely updates without requiring them to constantly check our system for changes. This makes it easier for our clients to stay up-to-date on the status of their orders and to respond quickly to any changes.

Specifying endpoint(s)

To receive webhook notifications for shipments, you need to provide us with the endpoint where we should send the message when you are generating your API key. The endpoint should be a publicly accessible URL that can receive and parse JSON payloads.

Security

To ensure the security of the webhook notifications we encourage you to specify a header and value that you would like us to include in each request.

Retry Policy

Currently, we do not support an automated retry for failed delivery. We do log these failures and will attempt to retry at a later point, however, the information provided in the webhook is always available in the get order details endpoint.

Conclusion

We hope that this document provides you with a clear understanding of how our webhook notification system works. If you have any questions or concerns, please do not hesitate to contact us.