Create a webhook

Use a webhook to notify an external application when an event occurs in AVEVA Enterprise Resource Management. For example, you can create a webhook called Publish to EXT1 with an event called PostUpdate to monitor when data is updated in AVEVA Enterprise Resource Management. When the PostUpdate event occurs, the Publish to EXT1 webhook is triggered and an external application is notified of the changes recorded during the PostUpdate event.

Additionally, you can use a webhook to trigger the import of data from an external application in the s22050 Data Import screen. For example, you can create a webhook called ImportDataFromEXT with a designated import staging area. In the s22050 Data Import screen, you can use the Import From Service functionality to import data from an external application to the staging area specified in the ImportDataFromExt webhook.

1. Navigate to the s15003 Webhooks screen.

2. To refresh the screen, select F5 key.

3. Select anywhere in the Webhooks grid.

4. On the Home menu, in the Record group, select Create.

   In the Webhooks grid, a blank row is created.

5. Select the General tab and perform the following:

   • In the Name field, enter the unique name of a webhook.

   • In the URL field, enter the URL of a webhook hosted on an external application.

   • From the Media Type dropdown, select the type of file received from an extremal application.

6. Perform one of the following according to your requirements:

   • To create a subscription to an event, from the Purpose dropdown, select Subscription, and perform the following:

     1. Select anywhere in the Subscriptions grid.

     2. On the Home menu, in the Record group, select Create.

        In the Subscriptions grid, a blank row is created.

     3. Select the General tab, from the Event Id dropdown, select the ID of an event.

   • To create a webhook to trigger a data import request, from the Purpose dropdown, select the Import tab, and perform the following:

     4. Select anywhere in the Import grid.

     5. On the Home menu, in the Record group, select Create.

        In the Import grid, a blank row is created.

     6. Select the Import tab, in the Id field, enter the unique ID of an import webhook.

     7. From the Appl dropdown, select the external application for data transfer.

     8. From the Import Staging Area dropdown, select the import staging area where the configuration files related to the data import are located.

     9. From the ImportConfig dropdown, select the configuration file related to an import staging area.

7. (Optional) Enter the relevant details in other fields as required. For more information on all the fields, see s15003 Field descriptions.

8. On the Home menu, in the Record group, select Save.

   The webhook is created.