← Back to connectors

ClickHelp connector for Okou

Connect your ClickHelp portal to manage documentation projects, publications, topics, files, users, workflow, and portal search through the REST API.

Docs & knowledge · Basic Authentication

Use ClickHelp in Okou

ClickHelp REST API v2 for documentation projects, publications, topics, files, users, workflow, portal search, reporting, and AnswerGenius.

Once connected, supported ClickHelp actions can become steps in a reusable workflow alongside the other services your team uses. Run the workflow once, on a schedule, or when an event starts it.

What you can do with ClickHelp

  • Read ClickHelp projects, publications, project access, and user-visible publication metadata.
  • Read ClickHelp topics, compiled content, metadata, and search snippets.
  • Read ClickHelp table-of-contents nodes and their children.
  • Read ClickHelp topic-view and portal-search activity for a bounded time range.
  • Search the connected ClickHelp portal's documentation.
  • Read ClickHelp file and folder metadata and optionally retrieve base64 file content.
  • Read ClickHelp user profiles and account metadata.
  • Send a question to ClickHelp AnswerGenius and receive its documentation-based answer.

How the ClickHelp connector works

A connected service becomes one permissioned step in the work you hand off.

  1. 1

    Connect ClickHelp

    Choose Basic Authentication.

  2. 2

    Choose the work

    Use only the supported actions your workflow needs.

  3. 3

    Run it your way

    Start it once, schedule it, or attach an event trigger.

Connect ClickHelp securely

Use the connection method that fits your account and grant only the access the workflow needs.

  • Basic Authentication

Connector access is controlled per service and per action, so a workflow does not need broader access than the work you ask it to do.

What ClickHelp covers

The topics this connector's published operations touch.

  • documentation
  • knowledge base
  • technical writing
  • content management
  • rest api

ClickHelp connector questions

What can Okou do with ClickHelp?
Connect your ClickHelp portal to manage documentation projects, publications, topics, files, users, workflow, and portal search through the REST API. Documented actions include: Read ClickHelp projects, publications, project access, and user-visible publication metadata. Read ClickHelp topics, compiled content, metadata, and search snippets.
How do I connect ClickHelp to Okou?
Connect ClickHelp using Basic Authentication. The connection controls which supported actions a workflow can use.
Can ClickHelp run in an automated workflow?
Yes. After it is connected, supported ClickHelp actions can run in reusable Okou workflows on demand, on a schedule, or from an event trigger.

More docs & knowledge connectors

Explore other connectors in the same product category.