Register Web Hook

Registers a new web hook.

Request

POST http:///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": "uri"
}

Properties

Name Type Description
description string String
id string String
isPaused boolean Boolean
secret string String
webHookUri uri Uri

Response

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

Status code Description Resource
200 OK

OK
201 Created

Created

 WebHook
400 Bad Request

Bad Request

 ProblemDetails
404 Not Found

Not Found

 ProblemDetails
409 Conflict

Conflict

 ProblemDetails
500 Internal Server Error

Internal Server Error