Create Webhook - 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 Register New 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 product ID. | 0 | 255 | Numeric | No |
| events | The event code(s) associated with the webhook. See Webhook Event Codes for information on the available event codes. | 0 | 3 | Array | No |
| webhookStatus | The webhook status. By default, the status is active. If you want to set the status to inactive. | 0 | 8 | String | 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 |
Response
The following table describes fields that included in the response after successfully registering a new webhook.
| Field | Description |
|---|---|
| webhookId | The unique identifier for the newly created webhook. |
| productId | The product ID from the request. |
| events | The event codes for the webhook. |
| webhookStatus | The status of the webhook. |
| url | The URL from the request. |
| customHeaders | The custom headers from the request. |
| createdTime | The date and time the webhook was created in UTC format. |
Updated 4 days ago