Ordergroove offers a webhook system designed to facilitate seamless integration between our platform and client systems. This system transmits HTTP requests in response to specific modifying events occurring within the Ordergroove ecosystem. Some examples of such events are: an order reminder being sent to a customer, a canceled subscription, a new subscription created, among others. The webhook system's primary function is to ensure that clients are informed of these critical events, thereby enabling real-time data synchronization.
Clients have the flexibility to configure webhook routes according to their specific requirements. This includes the ability to select only those events that are pertinent to their operational needs and to customize the content of the outgoing requests. Such configurability ensures that the webhooks provide targeted and relevant information, avoiding unnecessary data transmission.
The utilization of Ordergroove's webhook system is instrumental in bridging the gap between the management of subscription data on our platform and the execution of subsequent processes within external systems. This integration is vital for enhancing customer experience and improving operational efficiency.
This documentation aims to provide comprehensive guidance on the setup, configuration, and best practices for leveraging Ordergroove's webhook system to its fullest potential.
Webhooks 1.0 Retired
As of July 2024, all new and existing merchants use Webhooks 2.0. All merchants previously on 1.0 have migrated over.
What's the difference between 1.0 and 2.0?
Webhooks 2.0 is an enhanced version of Ordergroove’s previous webhook offering. It allows a merchant to combine multiple data points into a single webhook response.
Ordergroove’s webhook version prior to 2.0 would require additional API calls to get additional information such as shipping address, subscription extra_data, or customer information. Now, you can configure which data points are valuable to receive in a single webhook notification!
Webhook Benefits
Webhooks are proactive notifications, via HTTP requests from one application to another, that a specific event has occurred. Put simply, webhooks allow you to send Ordergroove to proactively contact your application(s) with information about the events that happen in your program - for example, if a subscription is created, an order is skipped, etc.
Here is a simplified example:
Webhooks allow you to create custom applications that automate or create additional functionality and experiences not otherwise native to Ordergroove's platform. Some examples you might use a webhook for:
- Automatically cancel a subscription after a certain number of shipments
- Update your CRM with information about subscribers, subscriptions, and orders
- Send additional marketing emails at significant points in a subscription or subscriber's lifecycle
Note: Ordergroove runs the webhook delivery process every 5 minutes, and anything that still is in the queue gets retried.
Glossary
Ordergroove event object: Entity within Ordergroove on which an event can occur. The four possible entities are:
Ordergroove webhook event: Payload representing an action taken by a customer, user, or system, which modifies an Ordergroove event object.
Target: The URL designated to receive the HTTP request body of an Ordergroove webhook event.
Webhook target: Alternative to “Target”.
Webhook route: A configuration unit in the Ordergroove system where the webhook target is specified and managed. This entity serves as the operational scope for various management activities, including halting webhook deliveries to the target, determining the specific events to be sent to the target, and other related actions.
Delivery: An Ordergroove webhook event bound to a specific route, representing an attempt to send an HTTP request to the configured target. Each delivery undergoes a series of statuses, reflecting its journey from initiation to completion. These statuses are determined by factors such as the successful transmission of the request to the target, the response received from the target, the need for request retries, and other relevant considerations. This progression of statuses provides insight into the lifecycle of each webhook event as it interacts with the target.