Configuring a Webhook

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 - Parameters are additional data that users can include in the URL when making a request to a webhook endpoint. They allow the user to send specific information or customise the request. Parameters are useful for customising the webhook request. For example, the user might include a parameter to filter the data they receive, to specify a date range, or to identify the source of the request.This can be configured in the parameters section

6. Select Authorisation - Authorisation in webhooks is a security mechanism used to ensure that only authorised users or systems can access and interact with the webhook. It involves verifying the identity of the sender and ensuring that they have the necessary permissions to perform certain actions via the webhook. Authorisation typically relies on tokens, keys, or credentials to authenticate the sender. In the Authorisation section, user can select from the dropdown the type of authorisation to use for their webhook request

7. Headers - Headers are a set of key-value pairs included in the HTTP request. They provide additional information about the request or the data being sent. Common headers include Content-Type, Authorisation, and User-Agent. For example, to include an authorisation header, the user might add "Authorisation: Bearer and UserAccessToken."

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 - 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

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.

Conclusion

The webhook has been configured successfully and all functionalities will now be available to users within the ops dashboard.