Setup Webhook event notifications
Introduction
Webhooks typically are used to connect two different applications. When an event happens on the trigger application, it serializes data about that event and sends it to a webhook URL from the action application—the one you want to do something based on the data from the first application.
On your Chord OMS you can listen to events so your integration can automatically trigger the desired actions
Architecture
Chord OMS uses webhooks to notify your application when an event happens in your account. Webhooks are particularly useful for asynchronous events like when an order is completed, canceled, or when a shipment changes status.
Begin using webhooks with your Chord OMS integration in just two steps:
- Create a webhook endpoint on your server.
Register the endpoint on the Chord OMS Dashboard to go live
What are webhooks?
Metaphorically, webhooks are like a phone number that Chord OMS calls to notify you of activity in your Chord OMS. The webhook endpoint is the person answering that call who takes actions based upon the specific information it receives.
Non-metaphorically, the webhook endpoint is just more code on your server. The webhook endpoint has an associated URL (e.g. ). The Chord OMS notifications are Webhook Event objects. This Webhook Event object contains all the relevant information about what just happened, including the type of event and the data associated with that event.
Webhooks refer to a combination of elements that collectively create a notification and reaction system within a larger integration.
Build a webhook endpoint
The first step to adding webhooks to your Chord OMS integration is to build your own custom endpoint. Creating a webhook endpoint on your server is no different from creating any page on your website.
Key considerations
Allowed HTTP status code
- 200
- 201
- 202
- 204
Event Types
If you have any questions or need help, please get in touch with us at help@chord.co.