Add Event Subscriptions - Field Descriptions

The following page describes the fields that can be used in the request and returned in the response for the Add Event Subscriptions endpoint.

Request

The following table describes the field that can be included in the body of the request when adding event subscriptions.

Field	Description	Type	Mandatory
events	The event codes to add to the webhook, as an array of integers. For example, `[101, 102]`. For more information, see Webhook Event Codes.	Array of integers	Yes

The following table describes the fields included in the response after successfully adding event subscriptions.

Field	Description
status	The status of the response. For example, `success`.
response	Object that contains the details of the update.
webhookId	The unique identifier of the webhook.
responseStatus	The status of the event subscription update. This is one of `Webhook events updated`, `Update failed` or `Webhook is not active`.
response	End of the response object.