Create Solution Article with Freshservice API on New Requests from HTTP / Webhook API

Pipedream makes it easy to connect APIs for Freshservice, HTTP / Webhook and 2,800+ other apps remarkably fast.

Trigger workflow on

New Requests from the HTTP / Webhook API

Next, do this

Create Solution Article with the Freshservice API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a HTTP / Webhook trigger and Freshservice action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Requests trigger
1. Optional- Configure Body Only
2. Optional- Configure Response Status Code
3. Optional- Configure Response Content-Type
4. Optional- Configure Response Body
5. Connect your HTTP / Webhook account
Configure the Create Solution Article action
1. Connect your Freshservice account
2. Configure Title
3. Configure Description
4. Select a Solution Category ID
5. Select a Solution Folder ID
6. Select a Solution Article Status
7. Optional- Select a Solution Article Type
8. Optional- Configure Tags
9. Optional- Configure Keywords
10. Optional- Configure Review Date
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Requests on HTTP / Webhook

Description: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.

Version:0.1.1

Key:http-new-requests

View on GitHub

HTTP / Webhook Overview#

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.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

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.

Trigger Code#

import http from "../../http.app.mjs";

// Core HTTP component
export default {
  key: "http-new-requests",
  name: "New Requests",
  description: "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.",
  version: "0.1.1",
  type: "source",
  props: {
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    emitBodyOnly: {
      type: "boolean",
      label: "Body Only",
      description: "This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.",
      optional: true,
      default: false,
    },
    resStatusCode: {
      type: "string",
      label: "Response Status Code",
      description: "The status code to return in the HTTP response",
      optional: true,
      default: "200",
    },
    resContentType: {
      type: "string",
      label: "Response Content-Type",
      description: "The `Content-Type` of the body returned in the HTTP response",
      optional: true,
      default: "application/json",
    },
    resBody: {
      type: "string",
      label: "Response Body",
      description: "The body to return in the HTTP response",
      optional: true,
      default: "{ \"success\": true }",
    },
    http,
  },
  async run(event) {
    const summary = `${event.method} ${event.path}`;

    this.httpInterface.respond({
      status: this.resStatusCode,
      body: this.resBody,
      headers: {
        "content-type": this.resContentType,
      },
    });

    if (this.emitBodyOnly) {
      this.$emit(event.body, {
        summary,
      });
    } else {
      this.$emit(event, {
        summary,
      });
    }
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
N/A	`httpInterface`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Body Only	`emitBodyOnly`	`boolean`	This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.
Response Status Code	`resStatusCode`	`string`	The status code to return in the HTTP response
Response Content-Type	`resContentType`	`string`	The `Content-Type` of the body returned in the HTTP response
Response Body	`resBody`	`string`	The body to return in the HTTP response
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

Action#

Create Solution Article on Freshservice

Description:Create a solution article. [See the documentation](https://api.freshservice.com/#create_solution_article)

Version:0.0.1

Key:freshservice-create-solution-article

View on GitHub

Freshservice Overview#

The Freshservice API opens up a realm of possibilities for streamlining IT service management processes. It allows you to interact programmatically with Freshservice features, such as creating tickets, managing users, updating service catalog items, and more. Leveraging the Freshservice API on Pipedream, you can automate repetitive tasks, create complex workflows that react to events in Freshservice in real time, and connect Freshservice to a multitude of other services to enhance its capabilities and your productivity.

Action Code#

import freshservice from "../../freshservice.app.mjs";

export default {
  key: "freshservice-create-solution-article",
  name: "Create Solution Article",
  description: "Create a solution article. [See the documentation](https://api.freshservice.com/#create_solution_article)",
  version: "0.0.1",
  type: "action",
  props: {
    freshservice,
    title: {
      type: "string",
      label: "Title",
      description: "The title of the solution article",
    },
    description: {
      type: "string",
      label: "Description",
      description: "The description of the solution article",
    },
    categoryId: {
      propDefinition: [
        freshservice,
        "solutionCategoryId",
      ],
    },
    folderId: {
      propDefinition: [
        freshservice,
        "solutionFolderId",
        (c) => ({
          solutionCategoryId: c.categoryId,
        }),
      ],
    },
    status: {
      propDefinition: [
        freshservice,
        "solutionArticleStatus",
      ],
    },
    articleType: {
      propDefinition: [
        freshservice,
        "solutionArticleType",
      ],
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "The tags of the solution article",
      optional: true,
    },
    keywords: {
      type: "string[]",
      label: "Keywords",
      description: "The keywords of the solution article",
      optional: true,
    },
    reviewDate: {
      type: "string",
      label: "Review Date",
      description: "Date in future when this article would need to be reviewed again. E.g. `2020-03-29T16:44:26Z`",
      optional: true,
    },
  },
  async run({ $ }) {
    const { article } = await this.freshservice.createSolutionArticle({
      $,
      data: {
        title: this.title,
        description: this.description,
        folder_id: this.folderId,
        article_type: this.articleType,
        status: this.status,
        tags: this.tags,
        keywords: this.keywords,
        review_date: this.reviewDate,
      },
    });
    $.export("$summary", `Successfully created solution article with ID ${article.id}`);
    return article;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Freshservice	`freshservice`	`app`	This component uses the Freshservice app.
Title	`title`	`string`	The title of the solution article
Description	`description`	`string`	The description of the solution article
Solution Category ID	`categoryId`	`string`	Select a value from the drop down menu.
Solution Folder ID	`folderId`	`string`	Select a value from the drop down menu.
Solution Article Status	`status`	`integer`	Select a value from the drop down menu:`{ "label": "Draft", "value": 1 }{ "label": "Published", "value": 2 }`
Solution Article Type	`articleType`	`integer`	Select a value from the drop down menu:`{ "label": "Permanent", "value": 1 }{ "label": "Workaround", "value": 2 }`
Tags	`tags`	`string[]`	The tags of the solution article
Keywords	`keywords`	`string[]`	The keywords of the solution article
Review Date	`reviewDate`	`string`	Date in future when this article would need to be reviewed again. E.g. `2020-03-29T16:44:26Z`

Action Authentication#

Freshservice uses API keys for authentication. When you connect your Freshservice account, Pipedream securely stores the keys so you can easily authenticate to Freshservice APIs in both code and no-code steps.

Your Freshservice API key is in your Profile > Settings page, below the change password section on the right.

Your domain is displayed in your Freshdesk URL. For example, https://{your_domain_here}.freshservice.com/.

About Freshservice#

Cloud-based IT Service Management solution

More Ways to Connect Freshservice + HTTP / Webhook#

Other Popular Integrations#

Create Solution Article with Freshservice API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Freshservice