Overview #

The LaunchBrightly Help Center Sync API is focused on two primary services, revolving around getting images out of and into a Help Center (knowledge base). These are:

• Importing (extracting) Images from your Help Center
• Syncing Images to your Center

The expectation is that the majority of the images are Product Screenshots, but the API will extract all images in all of your support articles. The API is designed and built in conjunction with the Product Screenshots API and we try by choice to make them complement each other. These two API's are also the foundation for our screenshot automation platform for customer support teams.

The API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses the well-recognized header convention x-api-key for passing your API key. We try hard to use standard HTTP response codes and verbs.

Supported Help Center Platforms #

• Zendesk
• Intercom
• Help Scout
• Helpjuice
• Kustomer
• Freshdesk
• KnowledgeOwl