Render an integration UI with GET method

Declared integration input errors return 422. Integration connection or configuration failures return 424, independently of the caller's GitBook authentication. Invalid or failing integration responses return 502. Transport failures remain 5xx. Failed actions are not automatically retried.

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

Pattern: ^[a-zA-Z0-9-_.]+$
Query parameters
requeststringRequired

LZ-string compressed JSON request

Responses
200

ContentKit element to render

application/json
Responseone of

Output of the integration when rendering a UI.

or
get/integrations/{integrationName}/render
GET /v1/integrations/{integrationName}/render?request=text HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "type": "element",
  "element": {
    "type": "block",
    "children": [
      {
        "type": "button",
        "style": "primary",
        "onPress": "[Circular Reference]",
        "icon": "close",
        "trailingIcon": "close",
        "label": "text",
        "tooltip": "text",
        "confirm": {
          "title": "text",
          "text": "text",
          "confirm": "text",
          "style": "primary"
        },
        "disabled": true
      }
    ],
    "controls": [
      {
        "icon": "close",
        "label": "text",
        "onPress": "[Circular Reference]",
        "confirm": {
          "title": "text",
          "text": "text",
          "confirm": "text",
          "style": "primary"
        }
      }
    ]
  },
  "state": {},
  "props": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
    }
  },
  "canAccessVisitorClaims": true
}

Last updated

Was this helpful?

Powered by GitBook