Registers a new web hook.

Request

POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/webhookregistrations

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

The request body takes a complete WebHook resource, containing the following writable properties:

{
    "description": "string",
    "id": "string",
    "isPaused": "boolean",
    "secret": "string",
    "webHookUri": "string"
}

Properties

Name Type
description string
id string
isPaused boolean
secret string
webHookUri string

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

WebHook