Resource: Channel
A notification channel used to watch for resource changes.
| JSON representation |
|---|
{ "params" : { string : string , ... } , "payload" : boolean , "id" : string , "resourceId" : string , "resourceUri" : string , "token" : string , "expiration" : string , "type" : string , "address" : string , "kind" : string } |
| Fields | |
|---|---|
params
|
Additional parameters controlling delivery channel behavior. Optional. An object containing a list of |
payload
|
A Boolean value to indicate whether payload is wanted. Optional. |
id
|
A UUID or similar unique string that identifies this channel. |
resourceId
|
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
resourceUri
|
A version-specific identifier for the watched resource. |
token
|
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
expiration
|
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
type
|
The type of delivery mechanism used for this channel. Valid values are "web_hook" or "webhook". |
address
|
The address where notifications are delivered for this channel. |
kind
|
Identifies this as a notification channel used to watch for changes to a resource, which is |
Methods |
|
|---|---|
|
Stops watching resources through this channel. |
