Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To run your webhook, navigate to Estimates in the Chartering module and open an estimate in details view. Then, expand the Notifications panel. In this panel, you will see the response message that is returned by the webhook.

...

The cards will be split into different sections based on the type of rule they are generated from (Tasks, Alerts, or Webhooks). These sections can be expanded/collapsed by clicking on the down/up carrot caret at the top of each section , and can be rearranged by the user so that the highest priority items are present at the top of the panel.

You can also access notifications in the Worksheet Estimate Column by selecting the double arrow icon >> to expand the Notifications panel for that Estimate, including Tasks, Alerts, and Webhooks.

Card details

The Webhook Card in the Notifications panel has a standard structure to it:

...

The name of the Rule from the Rule Set will be displayed in bold at the top of the card, followed by the any text that is sent back in the response payload.

...

If the response includes amutation, then the Apply to Estimate button will be displayed in the card. The user can click on this button which will update the details in the estimate with whatever fields were sent across in the mutation.

...

Lastly, there is a three-dot menu button at the top right of the card where the user can View the Tasks & Alerts Rule that triggered the card to be generated, Apply Suggested Changes which will be present only when there is a mutation, and acts the same as the Apply to Estimate button or Show Webhook Details. Selecting Show Webhook Details will open the Webhook Details form:

...