Comment on page
Integrations
An integration is the entity for an app developed on the GitBook Integrations Platform
post
https://api.gitbook.com/v1
/integrations/{integrationName}
Publish an integration
Parameters
Path
integrationName*
string
Name of the integration. Allowed characters are a-z, A-Z, 0-9, -, _, .
Body
Example
Schema
{
"icon": "string",
"title": "string",
"description": "string",
"summary": "string",
"previewImages": [
"string"
],
"visibility": "public",
"target": "organization",
"scopes": [
"entities:write"
],
"categories": [
"analytics"
],
"blocks": [
{
"id": "string",
"title": "string",
"description": "string",
"icon": "string",
"urlUnfurl": [
"string"
],
"markdown": {
"codeblock": "string",
"body": "string"
}
}
],
"externalLinks": [
{
"url": "string",
"label": "string"
}
],
"configurations": {
"account": {
"properties": {
"additionalProp1": {
"title": "string",
"description": "string"
},
"additionalProp2": {
"title": "string",
"description": "string"
},
"additionalProp3": {
"title": "string",
"description": "string"
}
},
"required": [
"string"
]
}
},
"script": "string",
"organization": "string",
"secrets": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"contentSecurityPolicy": "string",
"entities": [
{
"type": "string",
"title": {
"singular": "string"
},
"properties": [
{
"name": "string",
"title": "string",
"description": "string",
"deprecated": true
}
]
}
]
}
Responses
200: OK
OK
404: Not Found
Organization could not be found for the given hostname
default
Unexpected Error
delete
https://api.gitbook.com/v1
/integrations/{integrationName}
Unpublish an integration
Parameters
Path
integrationName*
string
Name of the integration. Allowed characters are a-z, A-Z, 0-9, -, _, .
Responses
204: No Content
Integration has been deleted
default
Unexpected Error
Last modified 7mo ago