Content
Overview
WeSupply has a new feature that your developers are going to love - Webhooks!
Webhooks are one way for apps to send automated messages or information to other apps.
They're a simple way for our system to "talk" to third-party systems like Slack, Messenger, WhatsApp, or others, in order to notify your shoppers when a new order update occurs.
Webhooks simplify automation without any need for manual input on both sides of the connection - notifying each other automatically about changes in order status, shipping status, or returns.
WeSupply Webhooks can be used as a medium to notify third-party applications when a particular event has happened. Instead of making repeated calls to pull data frequently from the WeSupply API, you can use webhooks to get information on events that happen when a notification is triggered.
Test WeSupply Webhooks
Testing WeSupply Webhooks takes you a few minutes.
We recommend RequestBin for testing, which allows you to generate a test URL that will capture requests sent to it and allow you to view details of those requests. This may be useful seeing test data sent from WeSupply via webhooks, before moving to production environments.
If you have in mind other tools that you can use while testing, feel free to use any others that you're comfortable with.
In many cases, knowing how to use webhooks is required before the third-party service will work with your app.
Step 1
Create your account or sign in on RequestBin.
Step 2
Click HTTP / Webhook:
Step 3
Next, choose again HTTP / Webhook:
Step 4
Under Popular ways to connect HTTP / Webhook with HTTP / Webhook section, select Custom Request:
Step 5
Now, insert a Name for this request and click Create Source.
Step 6
An endpoint URL will be generated to be used for testing WeSupply events.
Step 7
Log into your WeSupply account and go to Settings ->Integrations -> Webhook and API:
Step 8
In the Webhooks Events section, from the Events dropdown select, one of the available event triggers that you would like to test. For this article, we chose as an example the ''Order Received'' notification.
From the Type dropdown, select Custom URL.
In the URL field, paste the endpoint generated in RequestBin at Step 6 of this article.
Step 9
Click Add Webhook to enable the event and it will be listed as seen below.
Click Send test request to send a trigger in RequestBin.
Step 10
In RequestBin, go to Sources, and there you should have received a POST request from WeSupply. This request contains the order data associated with the Order Received notification.
Woohoo! The first test is done! Continue to test as many triggers as you need.
WeSupply Webhook Documentation
Our Webhook public documentation can be checked out here: Webhooks Doc
FAQs
Q: What WeSupply events can be sent via Webhooks integrations?
Here you'll find a brief explanation of all events that WeSupply is sending via webhooks.
WeSupply triggers events based on order updates, updates to in-store pickup and curbside orders, shipping updates, or return management.
- Order Events
Order Received - Order confirmation email - Triggered shortly after the order is placed by the customer (if the order is sent to WeSupply right away)
Order Cancelled - the option to cancel an item/product is enabled in WeSupply
Order Delayed - This notification will remind the customer that their order is still processing (usually due to increased sales volume or slow processing time) - Triggered when an order was not shipped out yet based on the configuration set in WeSupply
Order ETA - Product Eta notification - Triggered when a product is on backorder
- Shipping Events
Package Shipped - Also known as Shipment confirmation email - Trigged when a tracking number is assigned to an order
Shipment Received - Carrier has received the package from shipper - Triggered when the courier updates to this status
Shipment Picked Up - The package was picked up from a pickup location - Triggered when the courier updates to this status
Shipment In Transit - Carrier has accepted or picked up shipment from the shipper. The shipment is on the way - Triggered when the courier updates to this status. This might trigger overnight
Shipment Exception - An exception occurs when a package is temporarily delayed while in transit. Every effort is made to deliver every package as soon as possible, so an exception does not necessarily denote a late shipment. The status exception explains the most recent exception in the scan activity section. - Triggered when the courier updates to this status
Shipment Failed Attempt - Carrier attempted to deliver but failed - Triggered when the courier updates to this status
Shipment Out For Delivery - The package has left the delivery office with a carrier, and delivery is intended on that day. - Triggered when the courier updates to this status
Shipment Expired - Shipment has no tracking information for 30 days since added. - Triggered when the courier updates to this status
Shipment Delivered - Your package has been delivered and a delivery scan recorded the time and date of delivery. - Triggered when the courier updates to this status
- In-Store Pickup & Curbside Events
Customer is Waiting Outside - Store associate notification - Triggered when the item status is "Customer Waiting Outside"
Order Pickup Reminder - Notification reminder for orders ready for pickup - Triggered when the "x" days configured under Settings > Stores > Curbside & Store Pickup are passed
Order Received Store Pickup/Curbside - Order confirmation email for Store Pickup/Curbside - Triggered shortly after the order is placed by the customer (if the order is sent to WeSupply right away and contains pickup items)
Order is Unable to Fulfill - In-Store order is unable to fulfill - Triggered when the item status is "Unable to Fulfill"
Order is Ready for Pickup - In-Store order is ready for pickup - Triggered when the item status is "ready for pickup"
Order was Cancelled - In-Store order was canceled - Triggered when the item status is "Cancelled"
Order was Picked Up - In-Store order was picked up - Triggered when the item status is "Picked-Up"
Digital Receipt (Walk Out)
- Return Management Events
Return Approved Awaiting Tracking Number - Email confirmation of the approved return request, a return label was not generated for the customer, and the customer is required to input the tracking number as soon as they have it - Triggered as soon as a return request is approved, a return label is not generated by WeSupply and return method sends it back
Return Approved Label Generation - Email confirmation of the approved return request with a link to download the return label - Triggered as soon as a return request is approved and a return label is generated
Return Approved by store or ship back - Confirmation email that the return was approved, now the customer can select the return method In-Store or Ship it back - Triggered as soon as a return request is approved by the Returns Manager
Return Authorization pending - If a return requires manual review - Triggered if the return request matches a return logic that requires manual review
Return Confirmation Store Selected - Confirmation of the store location where the items are going to be returned - Triggered as soon as a return request is approved for a return to store process.
Return Confirmation Tracking Number Received - Email confirmation that the tracking number provided by the customer was received and it can be tracked in WeSupply - Triggered as soon as a tracking number is provided by the customer and input into WeSupply
Return Delivered - The shipment with the return has arrived at the return location, this notification should contain instructions such as "please allow 2-3 days to process your return and issue a refund" - Triggered as soon as the tracking number for the return is updated with the status "delivered" by the courier
Return Not Approved instructions - Return request rejected by the Returns Manager - Triggered after the Returns Manager rejects the return request for whatever reason (the reason is included in the email)
Return to store Approved - As soon as a return request is approved to be returned to a store - Triggered as soon as a return request is approved by the Returns Manager
Request Refund Issued - Refund successfully issued for the customer - Triggered as soon as a refund is issued within WeSupply
Comments
0 comments
Article is closed for comments.