Help Scout Docs

undefined

Detail	Value
Category	Support
Base URL	https://docsapi.helpscout.net/v1
Authentication	OAuth2 Client Credentials
Endpoints	6
Connector key	helpscout-docs

Using Help Scout Docs in a workflow

1. Go to Connections and click New Connection.
2. Pick Help Scout Docs from the marketplace.
3. Enter your credentials (see Authentication above for what's expected).
4. In a workflow, drop an API Call node and select this connection.
5. Pick the operation you need from the Operation dropdown. The full list is below.

Available endpoints

Endpoint	Summary
GET	List Collections
GET	List Articles
GET	Create Article
GET	Search Articles
GET	Manage Categories
GET	List Sites

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET

List Collections

Detail	Value
Operation ID	list_collections_0
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Help Scout Docs connection from the Connection dropdown.
3. In the Operation dropdown, select list_collections_0.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Help Scout Docs API reference.

GET

List Articles

Detail	Value
Operation ID	list_articles_1
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Help Scout Docs connection from the Connection dropdown.
3. In the Operation dropdown, select list_articles_1.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Help Scout Docs API reference.

GET

Create Article

Detail	Value
Operation ID	create_article_2
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Help Scout Docs connection from the Connection dropdown.
3. In the Operation dropdown, select create_article_2.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Help Scout Docs API reference.

GET

Search Articles

Detail	Value
Operation ID	search_articles_3
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Help Scout Docs connection from the Connection dropdown.
3. In the Operation dropdown, select search_articles_3.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Help Scout Docs API reference.

GET

Manage Categories

Detail	Value
Operation ID	manage_categories_4
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Help Scout Docs connection from the Connection dropdown.
3. In the Operation dropdown, select manage_categories_4.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Help Scout Docs API reference.

GET

List Sites

Detail	Value
Operation ID	list_sites_5
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Help Scout Docs connection from the Connection dropdown.
3. In the Operation dropdown, select list_sites_5.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Help Scout Docs API reference.