How to Add or Edit a Webhook in OMS?
PreviousHow to Add or Edit Shipping Details in OMS?NextHow to Add or Edit a State Transition in OMS?
Last updated
Was this helpful?
Last updated
Was this helpful?
This tutorial explains how to add or edit a webhook within the OMS screens. Webhooks are used to transfer events and data from the OMS to third-party software, enabling real-time communication and automation.
To add a new webhook, start by selecting the Settings tab under the Akinon OMS menu.
Next, click on Webhooks.
Click on the +New Webhook button to add new webhook.
To edit an existing webhook, follow the same steps to access Webhooks under the Settings tab. Select the webhook you want to edit from the list and proceed to its details.
Akinon OMS uses webhooks to relay the events it triggers to third-party software. These events can include outcomes stemming from OMS actions or updates regarding domain objects' current states.
The data required for the Webhook Form is furnished by the third-party software and can be customized through JSON configuration.
To add or edit a webhook, you need to provide the following information:
Target URL: The URL that other Akinon or third-party services receive to connect. The URL received by other Akinon or third-party services to connect.
Secret Ket: It is not a required field, if it is provided by other services to be connected.
Event Type: Enter a distinctive name to the Event Type field, especially if you have multiple webhooks, to differentiate them easily.
Callback: This field can be configured via JSON as needed.
Additional Headers: If there is extra data to be sent along with the settings or configuration, enter it here for routing from Akinon OMS to other Akinon or third-party services.
Config: The Config field allows you to provide a JSON Config in accordance with the specifications expected by the webhook.
Note: If there is no Additional Headers or Config to enter, these fields can be left empty by using "{}".
Retry Countdown Config: Specify a time interval for retrying data routing through this webhook, if necessary.
Status: Set the Status to Active if you want to use this webhook.
