​
Webhook taxonomy

Note: You should interpret the PRODUCT_UPDATED webhook as an upsert, as Rye currently does not send a separate event for when products are first created inside our system. This behavior is likely to change in future, as firing a separate PRODUCT_CREATED event is on our roadmap.

Product related webhooks are fired when our product catalog is updated. Subscriptions are created for your account when you request a product or store to be tracked by the Sell Anything API.

The product field in the webhook payload comes in a similar format to the response of the productByID query.

​
Order requires action webhooks

List of possible shipping carriers can be found here.

​
Sync API webhooks

If you are integrated with a Shopify merchant, we will send you webhooks when the state of the Rye Shopify app or sales channel changes.

We fire SHOPIFY_APP_CONNECTED and SHOPIFY_APP_DISCONNECTED events when the Shopify app is installed or uninstalled from the merchant’s store.

We also fire events when the set of products published to our sales channel updates:

  • SHOPIFY_PRODUCT_UPDATED - Fired when the product is published to the Rye sales channel, or when a product published to the Rye sales channel is updated (e.g. the merchant might have changed the product description).
  • SHOPIFY_PRODUCT_DELETED - Fired when a product is unpublished from the Rye sales channel.

Was this page helpful?

Webhooks Overview & SetupBest practices