Webhook
Represents a webhook. See WebhooksService to see how this entity is used in context.
Fields
Field | Type | Mode † | Description |
---|---|---|---|
buggy | Boolean | read-only | Returns true if this webhook was classified as buggy. A webhook is classified as buggy when there was an exception while building the payload for a notification for this webhook. The other reason for marking a webhook as buggy is when there was an exception while sending the notification to the remote system (eg. a 500 http error was returned). |
buggyDate | ISO 8601 Date | read-only | The date on which the webhook's buggy flag was set to true. If the webhook buggy flag is set to false, this field will be null. |
callback | String | required | The target URL that Jive will call with a JSON payload. If system is in not in dev mode, then callback must be HTTPs. The following headers will be sent as part of the callback:
|
enabled | Boolean | read-only | If false, Jive will not invoke the webhook callback URL even if the webhook conditions are met within Jive. |
events | String | optional | Valid event types depend on the object of the webhook. When object is a: Place: (Comma delimited list of content object types to listen for events about. List elements may be:)
Content:
User:
System events. To listen to system events you will need to leave object emtpy. These are the valid system events:
System events and content event types may not be mixed. This field must contain all system events, or all content events. |
followerCount | Integer | read-only | Number of people following this object. Availability:Will be present only for object types that support being followed. |
id | String | read-only | Identifier (unique within an object type and Jive instance) of this object. This field is internal to Jive and should not be confused with contentID or placeID used in URIs. |
likeCount | Integer | read-only | Number of people who have liked this object. Availability:Will be present only for object types that support being liked. |
object | String | required | URI of the parent containers (eg. groups) to filter events for, or the specific jive content object. |
published | ISO 8601 Date | read-only | Date and time this object was originally created. |
resources | Object | read-only | Resource links (and related permissions for the requesting person) relevant to this object. |
| String[] | optional | Tags associated with this object. Availability:Will be present only for object types that support tags |
updated | ISO 8601 Date | read-only | Date and time this object was most recently updated. |
followed | Boolean | read-only | Whether the current user is following this object. Availability:Will be present only for object types that support being followed. |