Support Integration
The Gearment Webhook API provides real-time notifications for critical order and product events—such as order completion, cancellation, shipping updates, stock changes, and variant modifications—across multiple payload versions to ensure seamless integration with your existing systems.
https://your-webhook-url/
Webhook events are one-way events sent to your app over HTTP to notify you when an event occured. Unlike events that are sent over Gateway connections, events sent over webhooks are not realtime or guaranteed to be in order.
While incoming webhooks are triggered by an external service, webhook events (i.e. outgoing webhooks) are triggered by events happening in Gearment. This means your app will need to set up a public URL where you can receive HTTP events, which is detailed in the preparing for events section.
You can configure only one webhook URL per webhook event and version.
To configure webhook events, you'll need to configure your URL and select the events you want your app to receive.
In your team's settings, navigate to the Webhooks page from the left-hand sidebar.
If your URL is successfully verified, your app should begin receiving the events you selected.
To test your webhook URL, you can use the Simulate Webhook feature. This allows you to send a test payload to your webhook URL to ensure that it is set up correctly and can handle incoming requests.
When Gearment sends an alert payload to your webhook URL, we include a variety of headers that you can use to verify that the payload came from QuickAlerts. For additional security, you can implement signature validation, which is an optional way to verify the authenticity of payloads received by your webhook URL.