Webhook Simulate POST

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/integration-service/webhook/{ID}/simulate

Refer to our documentation on URI syntax for more information on how to construct URIs.

Description

This method allows you to test registered webhook with test data which you can supply to see how the webhook will execute and make http requests.

If you have enabled Id Set acceptance then you will receive only one request which will contain the resource ids however if you have not then you will receive a request per resource id.

Note. A maximum of 10 resource ids may be supplied for the field resource ids. i.e. 1-10 or 1,5,9,22-26,101-102

Here is a list of the variables currently supported.

Field Description
${account-code} The account code of the brightpearl account.
${resource-type} The name of the resource. i.e. Product
${resource-id} An id set of all the effected resources.
${lifecycle-event} The lifecycle event such as Created.
${resource-specifier} The specifier for this resource.
${raised-on} Iso 8601 date time formatted time of when this event occurred. i.e. 2012-01-01T01:01:01Z
${brightpearl-version} The version of brightpearl which the account is on.

Example

Test webhook 12 with supplied test data.

Request URI

/webhook/12/simulate

Request body

{
	"testData": {
		"${account-code}": "myAccount",
		"${resource-type}": "product",
		"${resource-id}": "1-5,99,202",
		"${lifecycle-event}": "modified",
		"${resource-specifier}": "on-hand-modified",
		"${raised-on}": "2012-01-01T01:01:01Z",
		"${brightpearl-version}": "4.23.1"
	}
}