Webhooks

Form ID: (SM304000)

You use this form to register the MYOB Advanced webhooks for an external application; you can also use the form to view the details of requests to the webhook you select on the form. For details on registering webhooks, see Webhooks: General Information.

Form Toolbar

The form toolbar includes only standard buttons. For the list of standard buttons, see Form Toolbar and More Menu.

Summary Area

In this area, you can specify the main properties of a new webhook definition, or select a webhook to view its settings.


Element	Description
Webhook Name	Required. The name of the webhook.
Active	A check box that indicates (if selected) that this webhook is active and requests can be sent to its URL.
Implementation Class	Required. A webhook handler, which implements the PX.Api.Webhooks.IWebhookHandler interface. For details on creating a webhook handler, see Webhooks: General Information.
Predefined	Read-only. A check box that indicates (if selected) that the implementation class of the webhook is not available for editing in the instance. The Predefined box value can be modified in the Customization Project Editor. For details, see Webhooks.
URL	Read-only. The URL to which the requests from the external application should be sent. The system generates the URL when a user clicks the Save button after creating a new webhook. This process is called registration.

Request History Tab

You can use this tab to manage the history of the requests in the log, remove requests from the log, and check the statuses of the processing of requests for the selected webhook.

Table 1. Tab Selection Area
Element	Description
Requests to Keep	The types of requests to be stored in the log.
Maximum Number of Requests in History	The maximum number of requests to be stored in the log.

Table 2. Table Toolbar
The table toolbar includes standard buttons and buttons that are specific to this table. For the list of standard buttons, see Table Toolbar. The table-specific buttons are listed below.
Button	Description
Show Request Details	Opens the Request Details dialog box with the details of the request, the response, and any errors.
Clear History	Removes all requests from the log.

Table 3. Table Columns
Column	Description
Request	The type of the HTTP request: POST or GET.
Received From	The IP address from which the request was sent.
Date	The date and time when the request was sent.
Response Status	The status code of the request.

Table 4. Request Details Dialog BoxYou use this dialog box to view the details of the selected HTTP request. The dialog box provides a Summary area and two tabs.
Element	Description
The Summary area of the dialog box has the following elements.
Request	The type of the request.
Unnamed text box	The header and body of the request.
Response Status	The status code of the HTTP response.
Processing Time (ms)	The time in milliseconds it took to process the request.
The Response tab of this dialog box contains a text box that contains the header and body of the response.
The Exception Stack Trace tab of this dialog box contains the stack trace information, which you can use if an exception occurs.
The dialog box has the following buttons.
Close	Closes the dialog box.