Event

Events in GitBook occur when specific actions occur in a GitBook Space or environment. Your integration can tap into these events, read information about them, and dispatch actions as they occur.

They are declared within the createIntegration call, and should return async callback functions for the events you would like to listen to.

Example:

export default createIntegration({
    events: {
        space_view: async (event, context) => {
            // Handle event when the space your integration is installed in is viewed
        },
    },
});

Reference

The following events can be read on the event object passed into the arguments of the callback functions run when the event occurs.

installation_setup

Event received when integration has been installed or updated.

space_installation_setup

Event received when integration has been installed or updated on a space.

space_view

Event received when a page has been visited.

ui_render

Event generated when rendering a UI

space_content_updated

Event when the primary content of a space has been updated.

space_visibility_updated

Event when the visibility of the space has been changed.

space_gitsync_completed

Event when a GitSync operation has been completed.

space_gitsync_started

Event when a GitSync operation has been started.

Last updated