| id |
string |
The unique identifier for the webhook. |
| type |
string |
The type of webhook (e.g., client). |
| isHookEnabled |
boolean |
Whether the webhook is currently active and will process events. |
| notificationUrl |
stringnull |
The URL that receives POST notifications when monitored changes occur. |
| cursorForNextPayload |
integer |
The cursor position indicating the next unread payload. Used when polling for payloads. |
| areNotificationsEnabled |
boolean |
Whether HTTP notifications are currently being sent to the notification URL. |
| createdTime |
string |
The time when the webhook was created. |
| expirationTime |
string |
The time when the webhook will expire if not refreshed. Webhooks expire 7 days after creation or last refresh. |
| specification |
object |
The specification defining which changes the webhook monitors, including data types, field filters, and source options. |