Hoppa till huvudinnehållet
Tillbaka till sidans början

Enhancing Webhook Security and Integration Support

Ludovica
  • Uppdaterad

Purpose: Learn how to enable webhook feedback in Sendcloud and configure it for your specific integrations.

What is Webhook Feedback?

Webhook feedback enables your application to receive real-time updates from Sendcloud whenever a key event, such as a parcel status change, occurs. Instead of requiring manual or periodic data requests, Sendcloud automatically pushes these updates directly to your application.

Note: Webhook feedback differs from your shop feedback. While shop feedback is delivered directly to your webshop, webhook feedback is sent to a specific URL you designate. If you have already sent feedback to your shop system and activated this feature, updates will be sent to both your webshop and the selected URL.

API vs. Webhook:

  • API: Your application regularly sends requests to pull data, even when no new updates are available.
  • Webhook: Sendcloud automatically pushes data to your application as soon as an event occurs (e.g., parcel status change).

Example: Tracking Updates via Webhooks

  • API: Your application makes interval requests to pull tracking data from Sendcloud, regardless of whether new data is available.
  • Webhook: Sendcloud pushes tracking updates to your application immediately when new information is available, allowing you to provide real-time tracking to your customers.

If you want to know more, please refer to our article: What are webhooks and how to set them up in Sendcloud?

How to Set Up Webhooks in Sendcloud

1. Create an API Endpoint

To receive webhook updates, you need an API endpoint that can handle incoming requests from Sendcloud.

2. Configure Webhook Feedback in Sendcloud:

  1. Go to your Sendcloud panel and navigate to Settings > Integrations > Configure.
  2. Select the checkbox for Webhook feedback enabled.

3. Enter the Webhook URL:

  • Copy your Webhook URL from your application and paste it into the Webhook URL field in Sendcloud.

4. If present, set up a Webhook Signature Key:

This is a password used to sign all Sendcloud webhook requests. The key should:

  • Be at least 16 characters long 
  • Contain at least one number, one uppercase letter, one lowercase letter, and one special character.

5. Test Your Webhook:

Click on the Test API Webhook button to verify your setup. If your webhook is working correctly, you should start receiving payloads at your application.

6. Save:

Click Save to finalize the configuration.

Supported Webhook Events in Sendcloud

There are two categories of integrations supported by Sendcloud webhooks:

1. For API Integrations:

Sendcloud supports the following three webhook events:

  • Webhook Parcel Status Changed Event: Triggered whenever a parcel's status changes.
  • Webhook Integration Event: Triggered when a new API integration is connected, deleted, or updated in Sendcloud.
  • Webhook Refund Requested Event: Triggered when a refund is requested for a parcel.

2. For the following integrations:

Sendcloud supports only the Webhook Parcel Status Changed Event, which sends updates when there is a change in a parcel’s status:

  • Amazon 
  • Bol
  • CCVshop v2
  • Ebay
  • Epages
  • Etsy 
  • Lightspeed v2
  • Magento v2
  • Mijnwebwinkel
  • Prestashop
  • Prestashop v2
  • Shopify
  • Shopify v2
  • Woocommerce
  • Woocommerce v2

For these integrations, Sendcloud will push parcel status changes directly to your application, allowing for automated updates in your shop system.

Testing and Troubleshooting

Once your webhook is configured, it's essential to test it by clicking the Test API Webhook button in the Sendcloud panel. This will confirm that your setup is working correctly and that your endpoint is successfully receiving updates.

Important: Webhooks serve as notification triggers only—they do not perform any actions automatically. If you want to initiate actions such as sending tracking updates to customers or processing returns based on specific triggers, you’ll need to configure those workflows separately within your own system. For example, you might set up a process to handle tracking updates or returns after a particular status is received.