ClickHelp
AI-powered all-in-one documentation tool.
Integrate the ClickHelp API with the HTTP / Webhook API
Setup the ClickHelp API trigger to run a workflow which integrates with the HTTP / Webhook API. Pipedream's integration platform allows you to integrate ClickHelp and HTTP / Webhook remarkably fast. Free for developers.
Trusted by 1,000,000+ developers from startups to Fortune 500 companies
Popular Ways to Connect ClickHelp with HTTP / Webhook#
Popular ClickHelp and HTTP / Webhook Triggers#
Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.
Get a URL and emit the HTTP body as an event on every request
Emit new event when a topic is created. See the documentation
Emit new event when the content of the URL changes.
Popular ClickHelp and HTTP / Webhook Actions#
Generates a backup of the specified project. This action ensures you have a safe copy of your project in case of any unpredicted data loss. See the documentation
Creates a new publication from the designated project. This action allows you to share your content with others in various formats. See the documentation
Produces a new topic in the existing project. A useful action for starting a new chapter or section within your project. See the documentation
Send an HTTP request using any method and URL. Optionally configure query string parameters, headers, and basic auth.
Send an HTTP GET request to any URL. Optionally configure query string parameters, headers and basic auth.
Overview of ClickHelp#
The ClickHelp API allows technical writers to automate and interact with the ClickHelp documentation platform programmatically. With this API, Pipedream users can create, update, retrieve, and manage documentation projects, topics, and users within ClickHelp. It opens up opportunities to streamline documentation workflows, integrate with content management systems, and trigger notifications based on documentation changes or reviews.
Connect ClickHelp#
import { axios } from "@pipedream/platform"
export default defineComponent({
props: {
clickhelp: {
type: "app",
app: "clickhelp",
}
},
async run({steps, $}) {
return await axios($, {
url: `https://${this.clickhelp.$auth.portal_domain}/api/v1/users`,
auth: {
username: `${this.clickhelp.$auth.email}`,
password: `${this.clickhelp.$auth.api_key}`,
},
})
},
})
Overview of HTTP / Webhook#
Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.
Point and click HTTP requests
Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.
Focus on integrating, not authenticating
This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.
Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.
Compatible with no code actions or Node.js and Python
The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.
Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.
Connect HTTP / Webhook#
// To use any npm package on Pipedream, just import it
import axios from "axios"
export default defineComponent({
async run({ steps, $ }) {
const { data } = await axios({
method: "GET",
url: "https://pokeapi.co/api/v2/pokemon/charizard",
})
return data.species
},
})
Community Posts#
Trusted by 1,000,000+ developers from startups to Fortune 500 companies