Create a new WebHook

  1. Go to Admin.

  1. From the Interfaces and Diagnostics section , select Webhooks.
  2. Click Create a WebHook. The Webhooks Administration screen appears.

You can also access this screen and create new WebHooks by clicking Create new WebHook at the top of the WebHooks List screen (see Viewing existing WebHooks).

  1. Complete the screen, using this table as a guide. Fields marked with an asterisk * are mandatory, and you must complete them.

    Field

    Description/How to complete

    Event Type*

    Select the event type from the drop-down menu

    Entity*

    Type the entity

    Target URL*

    Type the URL that you want to send information about the event to

    Payload Type*

    Select the appropriate type from the drop-down menu

    HTTP Method*

    Select the appropriate method from the drop-down menu

    Authentication

    Select the appropriate authentication type from the drop-down menu

  1. At the bottom of the screen, click Create to add the new WebHook to the list on the WebHooks List screen.

Enabling a screen

The screen you want to use in the WebHook needs to be enabled. 

  1. Open the screen in question and select Action > Configure This Screen.
  1. Tick the box Enable Events Publishing.
  1. Click Save & Exit.