Help Center integration

We currently support Zendesk, Intercom, Helpscout, Helpjuice, Freshdesk, Mintlify and KnowledgeOwl. Stay tuned for more additional Help Center platforms.

This is one of two integration types managed by the Integration API. Once a Help Center integration exists, you can import using Auth to extract images from your articles.

Create Zendesk integration

Refer to Zendesk's documentation how to create an API token.

Request

{
  "label": "LaunchBrightly Zendesk Credentials",
  "provider": "zendesk",
  "platform": "helpcenter",
  "credentials": {
    "username": "hello@example.org",
    "token": "xxx",
    "subdomain": "https://yyy.zendesk.com"
  }
}

Response

{
  "id": "a7a0b392-4ec7-4b02-bef4-80c955ac674f",
  "createdAt": "2024-02-27T17:16:42.590Z",
  "updatedAt": "2024-02-27T17:16:42.590Z",
  "message": "The Integration credentials have been successfully created."
}

Create Intercom integration

Refer to Intercom's documentation how to create an API token.

Request

{
  "label": "LaunchBrightly intercom Credentials",
  "provider": "intercom",
  "platform": "helpcenter",
  "credentials": {
    "token": "your-token-goes-here"
  }
}

Response

Create Helpscout integration

Refer to Helpscout's documentation how to create an API token.

Request

{
  "label": "LaunchBrightly helpscout Credentials",
  "provider": "helpscout",
  "platform": "helpcenter",
  "credentials": {
    "token": "your-token-goes-here"
  }
}

Response

Create Helpjuice integration

Refer to Helpjuice's documentation how to create an API token.

Request

{
  "label": "LaunchBrightly helpjuice Credentials",
  "provider": "helpjuice",
  "platform": "helpcenter",
  "credentials": {
    "token": "your-token-goes-here",
    "subdomain": "https://example.helpjuice.com"
  }
}

Response

Create Freshdesk integration

Refer to Freshdesk's documentation how to create an API token.

Request

{
  "label": "LaunchBrightly freshdesk Credentials",
  "provider": "freshdesk",
  "platform": "helpcenter",
  "credentials": {
    "token": "your-token-goes-here",
    "subdomain": "https://example.freshdesk.com"
  }
}

Response

Create KnowledgeOwl integration

Refer to KnowledgeOwl's documentation how to create an API token.

Request

{
  "label": "LaunchBrightly knowledgeowl Credentials",
  "provider": "knowledgeowl",
  "platform": "helpcenter",
  "credentials": {
    "token": "your-token-goes-here",
    "subdomain": "https://example.knowledgeowl.com"
  }
}

Response

Create Mintlify integration

Refer to our Mintlify Integration documentation to set this up.

HTTP Status codes: