Update Webhook Details - 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 endpoint.

Request

The following table describes fields that can be included in the body of the request when registering a new webhook.

Field	Description	Min Length	Max Length	Type	Mandatory
productId	The code assigned to the product configured on the Thredd system.	0	255	Numeric	No
events	Event codes. This can be either: - 101 occurs when fraud rules are triggered by a transaction - 102 occurs when fraud alerts are acknowledged	0	3	Array	No
config	Object that contains the configuration information for the webhook. Must be included in the body.			Object	Yes
url	URL of your webhook endpoint. This must be HTTPS.	1	255	String	Yes
customHeaders	Custom headers to be passed along with the request. This is a lifecycle field that the you may want Thredd to always return as part of a webhook. You can have up to three name-value pairs.	0	500	Object	No

The following table describes fields that included in the response after successfully registering a new webhook.

Field	Description
status	Indicates whether the request was successful.
response	Object that returns the updated webhook information.
webhookId	The unique identifier assigned to the webhook.
productId	The code assigned to the product configured on the Thredd system.
webhookStatus	The current status of the webhook.
createdTime	The date and time the webhook was created.
lastModifiedTime	The date and time the webhook was last modified.
config	Object that contains the configuration information for the webhook. Must be included in the body.
url	URL of your webhook endpoint.
customHeaders	Custom headers to be passed along with the request.