Update Webhook Status - Field Descriptions

The following page details each of the fields that can be used in the request and received in the response when using the Update Webhook Status endpoint.

Request

The following table describes fields that can be included in the body of the request when updating a webhook's status.

Field	Description	Min Length	Max Length	Type	Mandatory
webhookStatus	The status you want to set the webhook to. Must be either `active` or `inactive`.	6	8	String	Yes

Response

The following table describes fields that included in the response after successfully updating a webhook's status.

Field	Description
webhookId	The unique identifier for the webhook.
webhookStatus	The current status of the webhook. Is either `active` or `inactive`.