Webhooks are fundamentally HTTP callbacks. In a nutshell, webhooks allows your system to get notified whenever some state you are interested in changes in a remote system (eg. Jive), avoiding the need to poll. It's a way to integrate systems based on the observer pattern, allowing your system to subscribe to events and get callback notifications.

External systems may register for and manage webhooks through this webservice. Jive will invoke an endpoint on the external system if the conditions for triggering the hook are met. Depending on the events field of the registered Webhook, Jive will send content or system webhook activity object notifications to the webhook endpoint.

Content webhooks

• jive:created
• jive:modified
• jive:commented
• jive:replied
• jive:liked
• jive:outcome_set

When these events occur, Jive will create an activity object and send it to the webhook callback. The activity event type is specified in the verb field of the webhook activity object, which is a standard V3 activity stream object, described below:

System webhooks

System webhooks are created by registering a webhook (1) not specifying any object field, and (2) specifying one or more of the supported event types in the events fields. Note that you cannot mix content types with system event types. Shown below are the different types of system events, and the range of values expected from the activity object verb field.

System webhook activity object fields:

For Jive Administrators: Webhooks tuning parameters

Examples

Shown below are examples of creating different types of webhooks. Perequisites:

• Register an addon and get the authorization code provided by Jive
• Exchange the authorization code for an ACCESS_TOKEN

Examples:

 curl -i -X POST "https://sample.jiveon.com/api/core/v3/webhooks"
         -H "Authorization: Bearer <ACCESS_TOKEN>"
         -H "Content-Type: application/json"
         -d'{
              "events" : "document",
              "callback": "http://your.service.com/webhooks",
              "object" : "https://sample.jiveon.com/api/core/v3/places/1020"
            }'
 

 curl -i -X POST "https://sample.jiveon.com/api/core/v3/webhooks"
         -H "Authorization: Bearer <ACCESS_TOKEN>"
         -H "Content-Type: application/json"
         -d'{
              "events" : "user_account,user_session,user_membership",
              "callback": "http://your.service.com/webhooks"
            }'
 

 curl -i -X POST "https://sample.jiveon.com/api/core/v3/webhooks"
         -H "Authorization: Bearer <ACCESS_TOKEN>"
         -H "Content-Type: application/json"
         -d'{
              "events" : "webhook",
              "callback": "http://your.service.com/webhooks"
            }'