Please ensure that you are using the Staging environment to test webhook integrations.

To notify you about updates to your submitted orders, Rye will send webhook notifications to your configured endpoint. This guide will walk you through how you can test the different types of webhook payloads that Rye might send during the lifetime of an order.

Webhook configuration

To configure your webhook endpoint, please follow the steps below:

  1. Head over to https://staging.console.rye.com/account
  2. Enter a valid callback endpoint for your backend under the “Webhook section”, and click save. This endpoint should be able to receive POST requests from Rye and respond with a 200 status code.

Testing webhooks

Some webhooks can be sent automatically in our staging environment, while others can’t. For example, since an order won’t actually be shipped in staging, Rye won’t be able to automatically send a TrackingObtained webhook. In order to test these types of webhooks, you can do the following:

  1. Create a test order in your staging account using this guide
  2. Once the order is visible in the “Orders” page, you should be able to see a “Test webhooks” column
  3. Select any of the webhook payload types
  4. Hit “Send” to send a test webhook payload to your configured URL!
  5. You should see a POST request to your webhook URL with the test webhook payload related to the test order

Additional information

For all information regarding webhooks, please refer to the webhooks section.