Renaming Events in a Webhook

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

Renaming Events

  1. During the configuration process, when the user selects the set of events they want to map to the status update webhook, they also have the option to rename these events as per their requirements

  2. These names are essentially aliases of the event names that are stored within Shipsy

  3. To do so, click on the rename events button

  4. This prompts a drawer style form on the right side of the screen 

  5. Here, the user will be able to see a list of all events that they selected earlier

  6. Next to each event name is a field where the users can input the relevant aliases for these events as per the requirements

  7. User can input aliases and save