Overview

We provide two Import options which both revolve around extracting images from your Help Center. This second option requires you to authenticate with your Help Center credentials. This option is more powerful and the recommended method and while it also returns a JSON response with all the images and their support article relationships, this response provides a more detailed response.

The authentication required is also a precursor to the Sync process, so ultimately where you would be headed.

Create an import job

POST /helpcenter/import

Data constraints

The following fields are required as JSON Payload.

{
  "integrationId": "d9e45598-d24d-40d8-baf6-33b6185c61b3"
}

Fields	Description
integrationId	See Help Center Integration Section

Check an Import Progress

GET /helpcenter/import/:import_job_id

Request

Data constraints

A valid :import_job_id is required.

Optional parameter:

By default, the response will be a list of images with their corresponding images. You can change the default output by appending a query string with the name dimension. For example:

GET /helpcenter/import/:import_job_id?dimension=articles

Supported values: articles or images (default)

dimensions	Description
images	Display a list of images with their corresponding articles
articles	Display a list of articles with their corresponding images

Success Response

Condition: If everything is OK

Code: 200

Content Example:

{
  "id": "f3940632-832f-4b84-8c50-0a68729bea7b",
  "summary": {
    "total": 45,
    "success": 45,
    "pending": 0,
    "failed": 0
  },
  "total": {
    "articles": 45,
    "images": {
      "total": 291,
      "unique": 145,
      "duplicate": 147
    },
    "authors": 0
  },
  "images": [
    {
      "url": "https://help.launchbrightly.com/hc/article_attachments/15673086642459",
      "cloud": null,
      "name": "15673086642459",
      "alt": "Launchbrightly-home-screen.png",
      "type": "png",
      "width": 2876,
      "height": 1642,
      "size": 334513,
      "hash": "233e5a21be9f879e363023e2fcf9a2ddca993ba576d12a6255a40b48ea1b1b63",
      "articlesCount": 1,
      "articles": [
        {
          "kbid": "15673272113051",
          "url": "https://help.launchbrightly.com/hc/en-us/articles/15673272113051-Select-the-Import-Help-Center-option-during-account-set-up",
          "title": "Select the Import Help Center option during account set up"
        }
      ]
    }
  ]
}

Error Response(s)

Condition: If the import job id is invalid or does not exist

Code: 404

Content Example:

{
  "message": "The job does not exist or invalid"
}

Retrieve an article

Request

GET /helpcenter/import/:external_article_id
{
"integrationId": "e240e5f7-ee66-4272-b2e3-d3a096791d46"
}

Data constraints

• An :external_article_id is required which corresponds to a unique identifier for the underlying help center's article. You can obtain the :external_article_id from GET /helpcenter/import/:id?dimension=articles

• An integrationId is required as part of the body payload. See Storage integration how to obtain one.

Response

{
  "id": "8444283",
  "content": "<p class=\"no-margin\">For a lot of designs rounded corners help draw attention and focus to the center of an image while sharp corners, in contrast, draw the eye away from the center.</p>",
  "images": [
    {
      "url": "https://launchbrightly.intercom-attachments-1.com/i/o/upload_14588685472463433686.png",
      "alt": "",
      "name": "upload_14588685472463433686.png",
      "type": "png",
      "width": 3152,
      "height": 576,
      "size": 55818,
      "hash": "b6975b10b36df3cc8e41b16a9be8c4f691aa1a2059d3dbcfde31d16fe6d5f65d",
      "metadata": {
        "name": "John",
        "surname": "Doe",
        "PoweredBy": "LaunchBrightly"
      }
    }
  ],
  "images_count": 1,
  "title": "Managing Editions from your help center import",
  "url": "https://intercom.help/lbdemo/en/articles/8444283-managing-editions-from-your-help-center-import",
  "importRequestId": "8444283",
  "createdOn": "2023-10-04T18:51:41Z",
  "tags": [
    ""
  ]
}

Update an article

Request

PUT /helpcenter/import/:external_article_id
{
  "integrationId": "e240e5f7-ee66-4272-b2e3-d3a096791de6",
  "screenshots": [
    {
      "metadata": {
        "name": "John",
        "surname": "Doe"
      },
      "hash": "4d441888f21eceed2443eef4ba9b4e4d6c198f86904c258d476fed10a6b2e555",
      "name": "raw-a1f99be5-2672-4cbc-9e60-61416932d848.png",
      "url": "https://lb-api-screenshots.s3.us-east-1.amazonaws.com/Dev_Hyder/2024-09-03/5e275c4b-d61c-4c5e-9391-e958afb64bb3.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIASH5PNXSCN5O7E7U2%2F20240903%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240903T201744Z&X-Amz-Expires=86400&X-Amz-Signature=bd45fd3104c0e6c9f3797fb3da54bf804d2027de5bdd25067eaa8531bac7fe91&X-Amz-SignedHeaders=host&x-id=GetObject"
    }
  ]
}

Data constraints

• A :external_article_id is required as part of the URL which corresponds to a unique identifier for the underlying help center's article.

• An integrationId is required as part of the body payload. See Storage integration how to obtain one.

• A content field is required as part the body payload which corresponds to the article's content.

Response

{
  "summary": {
    "total": 1,
    "success": 1,
    "failed": 0
  },
  "screenshots": [
    {
      "metadata": {
        "name": "John",
        "surname": "Doe",
        "PoweredBy": "LaunchBrightly"
      },
      "hash": "b6975b10b36df3cc8e41b16a9be8c4f691aa1a2059d3dbcfde31d16fe6d5f65d",
      "name": "upload_14588685472463433686.png",
      "status": "success",
      "matchType": "metadata"
    }
  ]
}

The matchType field shows the algorithm that were used to match the screenshot. It can either be metadata, hash, name or none.

Validate API Credentials

Please see integration connection verification endpoint.