> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/developers/gitbook-api/api-reference/integrations/list-all-integration-events.md).

# List all integration events

```json
{"openapi":"3.1.0","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"integrations","description":"Expand the capabilities of GitBook by connecting it with various external platforms—CRM, finding trackers, or CI/CD pipelines—through standardized integration endpoints.\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user":[]},{"user-internal":[]},{"user-staff":[]},{"integration":[]},{"integration-installation":[]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer"},"user-internal":{"type":"http","scheme":"bearer"},"user-staff":{"type":"http","scheme":"bearer"},"integration":{"type":"http","scheme":"bearer"},"integration-installation":{"type":"http","scheme":"bearer"}},"parameters":{"integrationName":{"name":"integrationName","in":"path","required":true,"description":"Name of the integration.","schema":{"type":"string","pattern":"^[a-zA-Z0-9-_.]+$","maxLength":100}},"listPage":{"name":"page","in":"query","description":"Identifier of the page results to fetch.","schema":{"type":"string"}},"listLimit":{"name":"limit","in":"query","description":"The number of results per page","schema":{"type":"number","minimum":0,"maximum":1000}}},"schemas":{"List":{"type":"object","properties":{"next":{"type":"object","properties":{"page":{"type":"string","description":"Unique identifier to query the next results page"}},"required":["page"]},"count":{"type":"number","description":"Total count of objects in the list"}}},"IntegrationEvent":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the event."},"integrationId":{"type":"string","description":"Unique ID of the integration."},"installationId":{"type":"string","description":"Unique ID of the integration installation."},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"payload":{"$ref":"#/components/schemas/Event"},"status":{"type":"string","description":"Status of the event.","enum":["success","failed"]}},"required":["id","integrationId","createdAt","payload","status"]},"Timestamp":{"type":"string","format":"date-time"},"Event":{"description":"Any event that can be received from GitBook.","oneOf":[{"$ref":"#/components/schemas/InstallationSetupEvent"},{"$ref":"#/components/schemas/InstallationDeletedEvent"},{"$ref":"#/components/schemas/SpaceInstallationSetupEvent"},{"$ref":"#/components/schemas/SpaceInstallationDeletedEvent"},{"$ref":"#/components/schemas/SiteInstallationSetupEvent"},{"$ref":"#/components/schemas/SiteInstallationDeletedEvent"},{"$ref":"#/components/schemas/SiteViewEvent"},{"$ref":"#/components/schemas/SpaceContentUpdatedEvent"},{"$ref":"#/components/schemas/SpaceGitSyncCompletedEvent"},{"$ref":"#/components/schemas/SpaceGitSyncStartedEvent"},{"$ref":"#/components/schemas/SpaceVisibilityUpdatedEvent"},{"$ref":"#/components/schemas/TaskEvent"},{"$ref":"#/components/schemas/FetchEvent"},{"$ref":"#/components/schemas/FetchPublishedScriptEvent"},{"$ref":"#/components/schemas/FetchVisitorAuthenticationEvent"},{"$ref":"#/components/schemas/UIRenderEvent"},{"$ref":"#/components/schemas/ContentComputeDocumentEvent"},{"$ref":"#/components/schemas/ContentComputeRevisionEvent"},{"$ref":"#/components/schemas/PageFeedbackEvent"}],"discriminator":{"propertyName":"type"}},"InstallationSetupEvent":{"allOf":[{"$ref":"#/components/schemas/InstallationEvent"},{"type":"object","description":"Event received when integration has been installed or updated.","properties":{"type":{"type":"string","enum":["installation_setup"]},"status":{"$ref":"#/components/schemas/IntegrationInstallationStatus"},"previous":{"type":"object","description":"The state of the installation at the account level before it was updated.","properties":{"status":{"$ref":"#/components/schemas/IntegrationInstallationStatus"},"configuration":{"type":"object","description":"The previous configuration of the installation at the account level."}},"required":["status"]}},"required":["type","status"]}]},"InstallationEvent":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"type":"object","description":"Common properties for all events related to an installation","properties":{"installationId":{"type":"string","description":"ID of the integration installation"}},"required":["installationId"]}]},"BaseEvent":{"description":"Common properties for all events.","type":"object","properties":{"eventId":{"description":"Unique identifier for the event.","type":"string"},"type":{"description":"Type of the event.","type":"string"}},"required":["eventId","type"]},"IntegrationInstallationStatus":{"type":"string","enum":["active","pending","paused"]},"InstallationDeletedEvent":{"allOf":[{"$ref":"#/components/schemas/InstallationEvent"},{"type":"object","description":"Event received when integration has been uninstalled from an organization.","properties":{"type":{"type":"string","enum":["installation_deleted"]},"previous":{"type":"object","description":"The state of the installation before it was deleted.","properties":{"configuration":{"type":"object","description":"The previous configuration of the installation."}}}},"required":["type","previous"]}]},"SpaceInstallationSetupEvent":{"allOf":[{"$ref":"#/components/schemas/SpaceEvent"},{"type":"object","description":"Event received when integration has been installed or updated on a space.","properties":{"type":{"type":"string","enum":["space_installation_setup"]},"status":{"$ref":"#/components/schemas/IntegrationInstallationStatus"},"previous":{"type":"object","description":"The state of the Space installation before it was updated.","properties":{"status":{"$ref":"#/components/schemas/IntegrationInstallationStatus"},"configuration":{"type":"object","description":"The previous configuration of the Space installation."}},"required":["status"]}},"required":["type","status"]}]},"SpaceEvent":{"allOf":[{"$ref":"#/components/schemas/InstallationEvent"},{"type":"object","description":"Common properties for all events related to a specific space.","properties":{"spaceId":{"type":"string","description":"ID of the space"}},"required":["spaceId"]}]},"SpaceInstallationDeletedEvent":{"allOf":[{"$ref":"#/components/schemas/SpaceEvent"},{"type":"object","description":"Event received when integration has been uninstalled from a space.","properties":{"type":{"type":"string","enum":["space_installation_deleted"]},"previous":{"type":"object","description":"The state of the Space installation before it was deleted.","properties":{"configuration":{"type":"object","description":"The previous configuration of the Space installation."}}}},"required":["type","previous"]}]},"SiteInstallationSetupEvent":{"allOf":[{"$ref":"#/components/schemas/SiteEvent"},{"type":"object","description":"Event received when integration has been installed or updated on a site.","properties":{"type":{"type":"string","enum":["site_installation_setup"]},"status":{"$ref":"#/components/schemas/IntegrationInstallationStatus"},"previous":{"type":"object","description":"The state of the site installation before it was updated.","properties":{"status":{"$ref":"#/components/schemas/IntegrationInstallationStatus"},"configuration":{"type":"object","description":"The previous configuration of the site installation."}},"required":["status"]}},"required":["type","status"]}]},"SiteEvent":{"allOf":[{"$ref":"#/components/schemas/InstallationEvent"},{"type":"object","description":"Common properties for all events related to a specific site.","properties":{"siteId":{"type":"string","description":"ID of the site"}},"required":["siteId"]}]},"SiteInstallationDeletedEvent":{"allOf":[{"$ref":"#/components/schemas/SiteEvent"},{"type":"object","description":"Event received when integration has been uninstalled from a site.","properties":{"type":{"type":"string","enum":["site_installation_deleted"]},"previous":{"type":"object","description":"The state of the site installation before it was deleted.","properties":{"configuration":{"type":"object","description":"The previous configuration of the site installation."}}}},"required":["type","previous"]}]},"SiteViewEvent":{"allOf":[{"$ref":"#/components/schemas/SiteEvent"},{"type":"object","description":"Event received when a page has been visited on a site.","properties":{"type":{"type":"string","enum":["site_view"]},"spaceId":{"type":"string","description":"Unique identifier of the visited space in the site.","deprecated":true},"siteSpaceId":{"description":"The site-space that was viewed","type":"string"},"pageId":{"type":"string","description":"Unique identifier of the visited page."},"visitor":{"$ref":"#/components/schemas/EventVisitor"},"url":{"type":"string","description":"The GitBook content's URL visited (including URL params)."},"referrer":{"type":"string","description":"The URL of referrer that linked to the page."}},"required":["type","visitor","url","referrer"]}]},"EventVisitor":{"type":"object","description":"Analytics info on the GitBook's content visitor.","properties":{"anonymousId":{"type":"string","description":"GitBook's unique identifier of the visitor."},"cookies":{"type":"object","description":"The visitors cookies.","additionalProperties":{"type":"string"}},"userAgent":{"type":"string","description":"User-agent of the visitor."},"ip":{"type":"string","description":"IP address of the visitor."},"language":{"type":"string","description":"Language of the visitor."}},"required":["anonymousId","cookies","userAgent","ip"]},"SpaceContentUpdatedEvent":{"allOf":[{"$ref":"#/components/schemas/SpaceEvent"},{"type":"object","description":"Event when the primary content of a space has been updated.","properties":{"type":{"type":"string","enum":["space_content_updated"]},"revisionId":{"type":"string","description":"Unique identifier of the new content revision"},"updatedBy":{"type":"array","description":"Users who updated the content","items":{"$ref":"#/components/schemas/User"}}},"required":["type","revisionId","updatedBy"]}]},"User":{"type":"object","properties":{"object":{"type":"string","description":"Type of Object, always equals to \"user\"","enum":["user"]},"id":{"type":"string","description":"Unique identifier for the user"},"displayName":{"type":"string","description":"Full name for the user"},"email":{"type":"string","description":"Email address of the user"},"photoURL":{"type":"string","description":"URL of the user's profile picture"},"urls":{"type":"object","description":"URLs associated with the object","properties":{"location":{"type":"string","description":"URL of the user in the API","format":"uri"}},"required":["location"]}},"required":["object","id","displayName","urls"]},"SpaceGitSyncCompletedEvent":{"allOf":[{"$ref":"#/components/schemas/SpaceEvent"},{"type":"object","description":"Event when a GitSync operation has been completed.","properties":{"type":{"type":"string","enum":["space_gitsync_completed"]},"state":{"type":"string","enum":["success","failure"]},"revisionId":{"type":"string","description":"Unique identifier of the new content revision"},"commitId":{"type":"string","description":"Unique identifier for the commit (sha)"}},"required":["type","state","revisionId","commitId"]}]},"SpaceGitSyncStartedEvent":{"allOf":[{"$ref":"#/components/schemas/SpaceEvent"},{"type":"object","description":"Event when a GitSync operation has been started.","properties":{"type":{"type":"string","enum":["space_gitsync_started"]},"revisionId":{"type":"string","description":"Unique identifier of the new content revision"},"commitId":{"type":"string","description":"Unique identifier for the commit (sha)"}},"required":["type","revisionId","commitId"]}]},"SpaceVisibilityUpdatedEvent":{"allOf":[{"$ref":"#/components/schemas/SpaceEvent"},{"type":"object","description":"Event when the visibility of the space has been changed.","properties":{"type":{"type":"string","enum":["space_visibility_updated"]},"previousVisibility":{"$ref":"#/components/schemas/ContentVisibility"},"visibility":{"$ref":"#/components/schemas/ContentVisibility"}},"required":["type","previousVisibility","visibility"]}]},"ContentVisibility":{"type":"string","description":"* `public`: Anyone can access the content, and the content is indexed by search engines.\n* `unlisted`: Anyone can access the content, and the content is not indexed by search engines\n* `share-link`: Anyone with a secret token in the url can access the content.\n* `visitor-auth`: Anyone authenticated through a JWT token can access the content.\n* `in-collection`: Anyone who can access the parent collection can access the content.\n  Only available for spaces in a collection.\n* `private`: Authorized members can access the content.\n","enum":["public","unlisted","share-link","visitor-auth","in-collection","private"]},"TaskEvent":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"type":"object","description":"Event representing a background task trigger for an integration.","properties":{"type":{"type":"string","enum":["task"]},"task":{"type":"object","description":"Payload associated with the integration task."}},"required":["type","task"]}]},"FetchEvent":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"type":"object","description":"Event representing an incoming HTTP request.","properties":{"spaceId":{"type":"string","description":"The space ID, if requests are specific to a single space"},"siteId":{"type":"string","description":"The site ID, if requests are specific to a single site"},"installationId":{"type":"string","description":"The installation ID, if requests are specific to a single installation"},"auth":{"type":"object","properties":{"userId":{"type":"string","description":"The user's ID."}},"required":["userId"]},"type":{"type":"string","enum":["fetch"]},"request":{"$ref":"#/components/schemas/FetchRequest"}},"required":["type","request"]}]},"FetchRequest":{"type":"object","properties":{"method":{"type":"string","enum":["post","get","put","delete"]},"url":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"string"}}},"required":["method","url","headers"]},"FetchPublishedScriptEvent":{"allOf":[{"$ref":"#/components/schemas/SiteEvent"},{"type":"object","description":"Common properties for all events related to fetching a published script from an installation","properties":{"type":{"type":"string","enum":["fetch_published_script"]}},"required":["type"]}]},"FetchVisitorAuthenticationEvent":{"allOf":[{"$ref":"#/components/schemas/SiteEvent"},{"type":"object","description":"Common properties for all events related to authenticated access from an installation","properties":{"type":{"type":"string","enum":["fetch_visitor_authentication"]},"location":{"type":"string"},"searchParams":{"type":"object","additionalProperties":{"type":"string"},"description":"Whitelisted search parameters from the visitor authentication request."},"action":{"type":"string","enum":["logout"],"description":"The visitor authentication action to resolve. If omitted, integrations resolve to the existing login redirect."}},"required":["type"]}]},"UIRenderEvent":{"allOf":[{"oneOf":[{"$ref":"#/components/schemas/SpaceEvent"},{"$ref":"#/components/schemas/SiteEvent"},{"$ref":"#/components/schemas/InstallationEvent"}]},{"type":"object","description":"Event generated when rendering a UI","properties":{"auth":{"type":"object","properties":{"userId":{"type":"string","description":"The user's ID."}},"required":["userId"]},"type":{"type":"string","enum":["ui_render"]},"componentId":{"type":"string"},"props":{"description":"Properties to render the UI.","type":"object"},"state":{"description":"State of the UI.","type":"object"},"context":{"$ref":"#/components/schemas/ContentKitContext"},"action":{"type":"object"}},"required":["type","componentId","props","context"]}]},"ContentKitContext":{"description":"Object representing the context in which a ContentKit component is rendered.","oneOf":[{"$ref":"#/components/schemas/ContentKitContextConfigurationAccount"},{"$ref":"#/components/schemas/ContentKitContextConfigurationSpace"},{"$ref":"#/components/schemas/ContentKitContextConfigurationSite"},{"$ref":"#/components/schemas/ContentKitContextConfigurationContentSource"},{"$ref":"#/components/schemas/ContentKitContextDocument"}]},"ContentKitContextConfigurationAccount":{"allOf":[{"$ref":"#/components/schemas/ContentKitContextBase"},{"type":"object","description":"Context while rendering in an account installation's configuration.","properties":{"type":{"type":"string","enum":["configuration_account"]},"organizationId":{"type":"string","description":"ID of the organization the account installation configuration is in."}},"required":["type","organizationId"]}]},"ContentKitContextBase":{"type":"object","description":"Common properties for ContentKit context.","properties":{"theme":{"type":"string","enum":["dark","light"]}},"required":["theme"]},"ContentKitContextConfigurationSpace":{"allOf":[{"$ref":"#/components/schemas/ContentKitContextBase"},{"type":"object","description":"Context while rendering in a space-installation's configuration.","properties":{"type":{"type":"string","enum":["configuration_space"]},"spaceId":{"type":"string","description":"ID of the space the space-installation configuration is in."}},"required":["type","spaceId"]}]},"ContentKitContextConfigurationSite":{"allOf":[{"$ref":"#/components/schemas/ContentKitContextBase"},{"type":"object","description":"Context while rendering in a site-installation's configuration.","properties":{"type":{"type":"string","enum":["configuration_site"]},"siteId":{"type":"string","description":"ID of the site the site-installation configuration is in."}},"required":["type","siteId"]}]},"ContentKitContextConfigurationContentSource":{"allOf":[{"$ref":"#/components/schemas/ContentKitContextBase"},{"type":"object","description":"Context while rendering the configuration flow of a content source.","properties":{"type":{"type":"string","enum":["configuration_contentsource"]},"organizationId":{"type":"string","description":"ID of the organization the content source installation configuration is in."},"spaceId":{"type":"string","description":"Optional ID of the space the content source installation configuration is in."}},"required":["type","organizationId"]}]},"ContentKitContextDocument":{"allOf":[{"$ref":"#/components/schemas/ContentKitContextBase"},{"type":"object","description":"Context while rendering in a document.","properties":{"type":{"type":"string","enum":["document"]},"spaceId":{"type":"string","description":"ID of the space content the document is in."},"editable":{"type":"boolean"}},"required":["type","spaceId","editable"]}]},"ContentComputeDocumentEvent":{"allOf":[{"$ref":"#/components/schemas/ContentComputeEvent"},{"type":"object","description":"Event generated when computing the document of a pages.\nThe integration should respond with a `Document`.\n","properties":{"type":{"type":"string","enum":["content_compute_document"]}},"required":["type"]}]},"ContentComputeEvent":{"allOf":[{"$ref":"#/components/schemas/SpaceEvent"},{"type":"object","description":"Generic event when computing the content of a space","properties":{"sourceId":{"type":"string"},"props":{"description":"Properties passed to the rendering.","$ref":"#/components/schemas/PlainObject"},"dependencies":{"description":"Dependencies of the computation.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ComputedContentDependencyResolved"}}},"required":["sourceId","props","dependencies"]}]},"PlainObject":{"properties":{},"additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/PlainObject"},{"type":"string"},{"type":"boolean"},{"type":"number"},{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"number"},{"$ref":"#/components/schemas/PlainObject"}]}}]}},"ComputedContentDependencyResolved":{"description":"Dependency for a computation, with its resolved value.","oneOf":[{"$ref":"#/components/schemas/ComputedContentDependencySpace"},{"$ref":"#/components/schemas/ComputedContentDependencyOpenAPI"},{"$ref":"#/components/schemas/ComputedContentDependencyTranslation"}]},"ComputedContentDependencySpace":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRefSpace"},"value":{"type":["object","null"],"description":"See `Space` schema component.","properties":{"object":{"type":"string","enum":["space"]},"id":{"type":"string"},"revision":{"type":"string"}},"required":["object","id","revision"]}},"required":["ref","value"]},"ContentRefSpace":{"type":"object","properties":{"kind":{"type":"string","enum":["space"]},"space":{"type":"string"}},"required":["kind","space"]},"ComputedContentDependencyOpenAPI":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRefOpenAPI"},"value":{"type":["object","null"],"description":"See `OpenAPI` schema component.","properties":{"object":{"type":"string","enum":["openapi-spec"]},"id":{"type":"string"},"slug":{"type":"string"},"lastVersion":{"type":"string"},"visibility":{"$ref":"#/components/schemas/OpenAPISpecVisibility"}},"required":["object","id","slug"]}},"required":["ref","value"]},"ContentRefOpenAPI":{"type":"object","properties":{"kind":{"type":"string","enum":["openapi"]},"spec":{"type":"string","description":"Slug of the OpenAPI specification"}},"required":["kind","spec"]},"OpenAPISpecVisibility":{"type":"string","description":"The visibility setting of the OpenAPI spec.\n* `private`: The spec is not publicly available.\n* `public`: The spec is available to anyone with a public link.\n","enum":["private","public"]},"ComputedContentDependencyTranslation":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/TranslationRef"},"value":{"oneOf":[{"$ref":"#/components/schemas/TranslationResult"},{"type":"null","description":"Translation has not been run yet"}]}},"required":["ref","value"]},"TranslationRef":{"type":"object","properties":{"kind":{"type":"string","enum":["translation"]},"translation":{"type":"string","description":"ID of the translation sync"}},"required":["kind","translation"]},"TranslationResult":{"type":"object","description":"Result of a translation.","properties":{"space":{"type":"string","description":"ID of the space containing the result of the translation"},"revision":{"type":"string","description":"ID of the revision generated by the translation"},"language":{"$ref":"#/components/schemas/TranslationLanguage"}},"required":["space","revision","language"]},"TranslationLanguage":{"type":"string","enum":["en","fr","de","es","it","pt","pt-br","ru","ja","zh","zh-tw","yue","ko","ar","hi","nl","pl","tr","sv","no","da","fi","el","cs","hu","ro","th","vi","id","ms","he","uk","sk","bg","hr","lt","lv","et","sl"]},"ContentComputeRevisionEvent":{"allOf":[{"$ref":"#/components/schemas/ContentComputeEvent"},{"type":"object","description":"Event generated when computing revision in a content.\nThe integration should respond with an array of pages and files.\n","properties":{"type":{"type":"string","enum":["content_compute_revision"]}},"required":["type"]}]},"PageFeedbackEvent":{"allOf":[{"$ref":"#/components/schemas/BaseEvent"},{"type":"object","description":"Event received when feedback has been submitted on a page.","properties":{"type":{"type":"string","enum":["page_feedback"]},"installationId":{"type":"string","description":"ID of the integration installation"},"spaceId":{"type":"string","description":"Unique identifier of the space in the site.","deprecated":true},"siteId":{"type":"string","description":"Unique identifier of the site."},"pageId":{"type":"string","description":"Unique identifier of the page where feedback was submitted."},"feedback":{"type":"object","description":"The feedback data submitted by the visitor.","properties":{"rating":{"$ref":"#/components/schemas/PageFeedbackRating"},"comment":{"type":"string","description":"Optional comment provided with the feedback.","minLength":1,"maxLength":512}},"required":["rating"]},"visitor":{"$ref":"#/components/schemas/EventVisitor"},"url":{"type":"string","description":"The GitBook content's URL where feedback was submitted."},"referrer":{"type":"string","description":"The URL of referrer that linked to the page."}},"required":["type","installationId","siteId","feedback","visitor","url","referrer"]}]},"PageFeedbackRating":{"type":"string","enum":["bad","ok","good"]}}},"paths":{"/integrations/{integrationName}/events":{"get":{"operationId":"listIntegrationEvents","summary":"List all integration events","tags":["integrations"],"parameters":[{"$ref":"#/components/parameters/integrationName"},{"$ref":"#/components/parameters/listPage"},{"$ref":"#/components/parameters/listLimit"}],"responses":{"200":{"description":"Paginated list of integration events","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/List"},{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationEvent"}}}}]}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://gitbook.com/docs/developers/gitbook-api/api-reference/integrations/list-all-integration-events.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.