blue webhooks- receive automated event notifications
Webhooks are user-defined HTTP callbacks, automatic messages that allow you to be notified about events relevant to your account, such as label cost adjustments and refunds.
Events supported by blue webhooks are:
- Pending adjustments - these events will occur twice a month, the 1st and the 11th of every month, for the same label. If you choose to be notified about pending adjustments, you will receive two pending_adjustment events for one label, one on the 1st and the second on the 11th of the month. Note: The two notifications you will receive do not mean that the adjustment will be charged twice. Each adjustment will only be charged once.
- Approved adjustment - this event will occur whenever your account is charged for the adjustment. It usually happens after the 21st of the month. To learn more about label cost adjustments, please click here.
- Refund approved - this event will occur whenever a label refund is approved. To learn more about refunds, please go here.
- Refund rejected - this event will occur whenever a label refund is rejected.
- Accepted Tracking event received - this event will occur once USPS receives a package.
- In transit tracking event received - this event will occur once our system receives this tracking status
- Delivered tracking event received - this event will occur once a package is delivered
- Return to sender tracking event received
- Report completed
- Return label charged
Here is how you can easily configure the webhooks via the a) blue web application and the b) blue API.
a) Configure webhooks via the blue web application
First you need to create one or more webhook endpoints on your server.
Log in to your blue account, and go to Settings>Webhooks, as shown on the image below.
Click 'Add New'.
Input your preferred URL and choose events you'd like to be notified about on that specific URL. Secret is optional, and it represents the endpoint’s secret key, used to generate webhook signatures. This is a recommended security feature, to assure that notifications are generated by us. When you are finished, click 'Create'.
You also have the option to configure multiple webhook endpoints, to receive different event notifications on different endpoints.
b) Configure webhooks' via the blue API
First, you need to create one or more webhook endpoints on your server. To learn how to set up one or more webhooks' via the blue API, please check out our API documentation.
If you have any additional questions, or need assistance, please don't hesitate to contact us at support@myibservices.com.