Appearance
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.
POST /integration
Request
json
{
"label": "LaunchBrightly Zendesk Credentials",
"provider": "zendesk",
"platform": "helpcenter",
"credentials": {
"username": "hello@example.org",
"token": "xxx",
"subdomain": "https://yyy.zendesk.com"
}
}Response
json
{
"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."
}| Fields | Description |
|---|---|
| provider | Supported values: zendesk, intercom, helpscout, helpjuice, freshdesk, mintlify or knowledgeowl. |
| platform | helpcenter or cloud |
| credentials.username | The username/email of your Zendesk account |
| credentials.token | A valid API token obtained from Zendesk |
| credentials.subdomain | Your Zendesk url e.g https://example.zendesk.com |
Create Intercom integration
Refer to Intercom's documentation how to create an API token.
Request
json
{
"label": "LaunchBrightly intercom Credentials",
"provider": "intercom",
"platform": "helpcenter",
"credentials": {
"token": "your-token-goes-here"
}
}Response
json
{
"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."
}| Fields | Description |
|---|---|
| provider | Supported values: zendesk, intercom, helpscout, helpjuice, freshdesk, mintlify or knowledgeowl. |
| platform | helpcenter or cloud |
| credentials.token | A valid API token obtained from Intercom |
Create Helpscout integration
Refer to Helpscout's documentation how to create an API token.
Request
json
{
"label": "LaunchBrightly helpscout Credentials",
"provider": "helpscout",
"platform": "helpcenter",
"credentials": {
"token": "your-token-goes-here"
}
}Response
json
{
"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."
}| Fields | Description |
|---|---|
| provider | Supported values: zendesk, intercom, helpscout, helpjuice, freshdesk, mintlify or knowledgeowl. |
| platform | helpcenter or cloud |
| credentials.token | A valid API token obtained from Helpscout |
Create Helpjuice integration
Refer to Helpjuice's documentation how to create an API token.
Request
json
{
"label": "LaunchBrightly helpjuice Credentials",
"provider": "helpjuice",
"platform": "helpcenter",
"credentials": {
"token": "your-token-goes-here",
"subdomain": "https://example.helpjuice.com"
}
}Response
json
{
"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."
}| Fields | Description |
|---|---|
| provider | Supported values: zendesk, intercom, helpscout, helpjuice, freshdesk, mintlify or knowledgeowl. |
| platform | helpcenter or cloud |
| credentials.token | A valid API token obtained from Helpjuice |
| credentials.subdomain | Your Helpjuice url e.g https://example.helpjuice.com |
Create Freshdesk integration
Refer to Freshdesk's documentation how to create an API token.
Request
json
{
"label": "LaunchBrightly freshdesk Credentials",
"provider": "freshdesk",
"platform": "helpcenter",
"credentials": {
"token": "your-token-goes-here",
"subdomain": "https://example.freshdesk.com"
}
}Response
json
{
"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."
}| Fields | Description |
|---|---|
| provider | Supported values: zendesk, intercom, helpscout, helpjuice, freshdesk, mintlify or knowledgeowl. |
| platform | helpcenter or cloud |
| credentials.token | A valid API token obtained from Freshdesk |
| credentials.subdomain | Your Freshdesk url e.g https://example.freshdesk.com |
Create KnowledgeOwl integration
Refer to KnowledgeOwl's documentation how to create an API token.
Request
json
{
"label": "LaunchBrightly knowledgeowl Credentials",
"provider": "knowledgeowl",
"platform": "helpcenter",
"credentials": {
"token": "your-token-goes-here",
"subdomain": "https://example.knowledgeowl.com"
}
}Response
json
{
"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."
}| Fields | Description |
|---|---|
| provider | Supported values: zendesk, intercom, helpscout, helpjuice, freshdesk or knowledgeowl. |
| platform | helpcenter or cloud |
| credentials.token | A valid API token obtained from KnowledgeOwl |
| credentials.subdomain | Your KnowledgeOwl url e.g https://example.knowledgeowl.com |
Create Mintlify integration
Refer to our Mintlify Integration documentation to set this up.
HTTP Status codes:
| HTTP Code | Description |
|---|---|
| 200 | On success |
| 422 | Any validation-related errors |
| 500 | Any unhandled exceptions |