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.

Before testing your integration, you should have followed our tutorial up to Step 2.

Testing webhooks

Most webhooks behave the same way in staging as they do in production, and will fire in response to events occurring inside the Rye platform. Product-related webhooks, for instance, will fire in staging whenever a product updates and you have an active subscription for that product.

Webhooks which fire after order placement, on the other hand, do not get fired in staging as orders placed using test cards are not processed. To test these webhooks—and to verify the correct implementation of your webhook handler on-demand—you can manually trigger test webhooks from within the Rye console by following the steps below.


Create a test order

Follow our guide on creating a test order so you have an order to fire webhooks for.


Navigate to the orders page

In the staging environment the orders page will have an additional “Test webhooks” column.


Select a webhook type

A variety of test webhook types are available in the dropdown inside the “Test webhooks” column. Select which one you would like to test.

The types for each webhook type can be found here.


Fire the webhook

Click the “Send” button next to the webhook type dropdown to send a test webhook payload to your configured webhook endpoint.


Receive the webhook

You should see a POST request come in to your webhook endpoint with the test webhook payload related to the test order.


Additional information

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