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. For more information, see Webhook Event Codes. | 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 |
| certificateAuthority | The webhook certificate authority used by the service. For example, Amazon Web Services (AWS). | 2 | 3 | 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 the fields included in the response after successfully updating webhook details.
| Field | Description |
|---|---|
| status | Indicates whether the request was successful. For example, success. |
| 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. |
| events | The event codes the webhook is subscribed to, as an array of integers. |
| webhookStatus | The current status of the webhook. This is either active or inactive. |
| config | Object that contains the configuration information for the webhook. |
| url | The URL of your webhook endpoint. |
| customHeaders | Custom headers to be passed along with the request. |
| config | End of the config object. |
| createdTime | The date and time the webhook was created, in UTC. Format is yyyy-MM-ddTHH:mm:ssZ. |
| lastModifiedTime | The date and time the webhook was last modified, in UTC. Format is yyyy-MM-ddTHH:mm:ssZ. |
| response | End of the response object. |
Updated 3 days ago
Did this page help you?