Skip to main content

​
Overview

Webhooks enable one service to automatically send real-time updates to another, eliminating the need for manual checks. Think of them as instant notifications - whenever a specific event occurs in the sending system, the receiving system is alerted immediately. In the context of thanks.io, webhooks provide an efficient way to receive proactive alerts about various events, including USPS tracking updates and QR Code Scans. Common webhook use cases include:
  • Receiving notification when a recipient scans the QR Code on a mailer
  • Getting notified when mailpieces fails to send
  • Triggering workflows upon final delivery confirmation

​
Order Metadata

Every event payload includes order.metadata: the JSON object you submitted with the order in the metadata field of a Send Mailer request, returned exactly as you sent it. Use it to match an event back to a record in your own system without having to store thanks.io order IDs. order.metadata is null for orders created without metadata, including orders created from the dashboard.

​
Webhooks Management

You can add any number of webhooks from the Webhooks Management page: https://dashboard.thanks.io/profile/webhooks From this page, you can easily:
  • Create new webhooks
  • Edit existing webhooks
  • Test webhook deliveries
  • Delete webhooks