Settings in a Webhook Integration

Owned by eknoor.singh (Unlicensed)
Nov 06, 2023
2 min read

Using this document, Shipsy users can learn how to configure a Webhook integration as per their requirements.

Instructions

Navigating to the Integration Marketplace

  1. Click on the menu icon and click on integrations

  2. From the sub menu, select Integration Marketplace

Navigating to the Webhooks Tab

  1. To navigate to the list of all available webhooks, users need to click on the webhooks tab

  2. From the tile view of all available webhooks, the user must select the webhook they want to integrate with and click on it’s tile

  3. They will then be directed to the overview page of the selected webhook where they will be able to see the summary, uses and the list for the support documentation provided

Configuring a Webhook

  1. Click on the Add Webhook button

  2. Enter the name of the webhook

  3. Select events - After this, the user may select all events they want to use this webhook for. This can be done by clicking on the different events that are listed on the right hand side of the page. A user may select as many events as they want to while configuring their webhook

  4. Select the type of request - the default selection is POST - and input the request URL

    1. The user will also have the functionality to test this URL at this point by clicking the TEST button

  5. Configure Parameters

  6. Select Authorisation

  7. Headers

  8. In the Body sub-tab the user can view the request body that will be provided to their customers from Shipsy’s end. Here, depending on their use case, users may select between on-demand and default webhook

  9. Settings

  10. Clicking on Save will finalise the configuration for that webhook and it will then be visible as a line item on the webhook overview page.

Webhook Settings

Under the settings sub-tab, the user will have the option to configure advanced settings for their webhook including using a static IP address and defining the triggers. The following settings are available:

  1. Use Static IP Address - Webhooks often carry sensitive data or trigger critical actions in a system. Using a static IP address for the sender provides an added layer of security. It allows the receiving system to verify the authenticity of incoming requests and ensure they are originating from a trusted source. Webhook senders with static IP addresses provide a consistent and reliable point of contact for the receiving system. This reduces the risk of disruptions in data transmission due to changing IP addresses, which can occur in dynamic IP configurations.

  2. Send Raven Link - This setting is used to enable or disable whether the webhook will also be used to update the tracking information provided on the raven link. Please note that these updates will only be available for limited events.

  3. Triggers - This setting is used to configure whether to trigger the webhook on Parent consignment, child consignment or both.