Webhooks are a feature that allows your application to automatically receive notifications whenever there is a change or update in the Biteship system, such as a change in shipping status. By using webhooks, you can send notifications to your e-commerce system or internal application in real-time, providing customers with up-to-date information about their shipping status. Below is a step-by-step guide to setting up webhooks in Biteship.
Steps to Set Up Webhooks in Biteship
1. Log in to the Biteship Dashboard
Open your account on Biteship by logging into the dashboard. Make sure you have access to API and webhook settings.
2. Navigate to Webhook Settings
On the dashboard, look for the Integration menu and select the Webhook option. This page allows you to set the webhook endpoint that will receive notifications from Biteship.
3. Add a New Webhook Endpoint
Click Add Webhook to get started. You will be asked to enter the endpoint URL that will receive notifications from Biteship. Make sure this endpoint is publicly accessible and able to receive and process JSON data.
4. Select the Types of Notifications You Want to Receive
Choose the types of shipping notifications you want to receive via webhook. Some available notification types may include:
order.status
The webhook will be triggered whenever there is a status update.order.price
The webhook will be triggered whenever there is a price change. This happens when the shipping rate differs from the actual weight.order.waybill_id
The webhook will be triggered whenever there is an update to your waybill number.
5. Save the Webhook Settings
After entering the endpoint URL and selecting the notification types, click Create New to activate the webhook. Now, Biteship will automatically send notifications to the endpoint you specified whenever there is a shipping status update.
6. Test the Webhook to Ensure Functionality
Before starting to use it, perform a test to ensure the webhook works properly. You can send a test notification from the dashboard or monitor the first incoming notification to check if the data is correctly received by your endpoint.
Tips to Optimize Webhook Usage
Use a Reliable Receiving System: Make sure your endpoint is ready to receive notifications at any time. Webhooks require a responsive server to handle notifications in real-time.
Store Notification Data: Save the data received from webhooks for record-keeping or tracking shipping status, so you have a complete history of shipment statuses.
Verify the Notification Source: Make sure to verify that notifications indeed come from Biteship by checking the signature or token sent along with the payload (if available) to prevent unauthorized notifications.
Frequently Asked Questions
Can I set up more than one webhook for my account?
Yes, you can set up multiple webhooks to receive different notifications. For example, one webhook for shipping and another for payments or billing, depending on the settings supported by Biteship.Is there a limit to the frequency of webhook notifications?
The frequency of webhook notifications depends on your shipping activity and status updates. Biteship sends notifications only when there are updates, so the number of notifications corresponds to changes in shipping status.
If you have further questions, please contact support@biteship.com.