Render an integration UI with POST method

post

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

integrationNamestring · max: 100Required

Name of the integration.

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

Body

application/json

componentIdstringRequired

ID of the component to render in the integration.

stateobjectOptional

Current local state of the UI.

contextone ofRequired

Object representing the context in which a ContentKit component is rendered.

or

or

or

or

actionany ofOptional

or

anyOptional

or

or

or

or

Responses

200

ContentKit element to render

application/json

Responseone of

Output of the integration when rendering a UI.

or

post/integrations/{integrationName}/render

HTTPcURLJavaScriptPython

POST /v1/integrations/{integrationName}/render HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 294

{
  "componentId": "text",
  "props": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
      }
    }
  },
  "state": {},
  "context": {
    "theme": "dark",
    "type": "configuration_account",
    "organizationId": "text"
  },
  "action": {
    "action": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

200

ContentKit element to render

{
  "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
}