Create Ticket Field with Freshdesk API on New Article Published from New York Times API

Pipedream makes it easy to connect APIs for Freshdesk, New York Times and 2,800+ other apps remarkably fast.

Trigger workflow on

New Article Published from the New York Times API

Next, do this

Create Ticket Field with the Freshdesk 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 New York Times trigger and Freshdesk action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Article Published trigger
1. Connect your New York Times account
2. Configure timer
3. Optional- Configure Facet
4. Optional- Select one or more Facet Fields
5. Optional- Configure Facet Filter
6. Optional- Configure Field List
7. Optional- Configure Filtered Query
8. Optional- Configure Query
9. Configure alert
Configure the Create Ticket Field action
1. Connect your Freshdesk account
2. Configure Label
3. Configure Label for Customers
4. Configure Type
5. Optional- Configure Customers Can Edit
6. Optional- Configure Displayed to Customers
7. Optional- Configure Position
8. Optional- Configure Required for Closure
9. Optional- Configure Required for Agents
10. Optional- Configure Required for Customers
11. Optional- Configure Choices
12. Optional- Configure Dependent Fields
13. Optional- Configure Section Mappings
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 Article Published on New York Times

Description:Emit new event when an article is published.

Version:0.0.1

Key:new_york_times-new-article

View on GitHub

New York Times Overview#

The New York Times API offers a variety of endpoints to access different types of news and information. With Pipedream, you can tap into this wealth of data to automate tasks, enrich applications with the latest news, or even analyze trends. Workflows on Pipedream triggered by NYT's API can range from sending daily news briefings to your communication platform, to analyzing article metadata for SEO research, or even keeping track of the most popular stories for content curation.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import moment from "moment";
import app from "../../new_york_times.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "new_york_times-new-article",
  name: "New Article Published",
  description: "Emit new event when an article is published.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    facet: {
      type: "boolean",
      label: "Facet",
      description: "Whether to show facet counts.",
      optional: true,
    },
    facetFields: {
      type: "string[]",
      label: "Facet Fields",
      description: "Use facets to view the relative importance of certain fields to a search term, and gain insight about how to best refine your queries and filter your search results.",
      options: [
        "day_of_week",
        "document_type",
        "ingredients",
        "news_desk",
        "pub_month",
        "pub_year",
        "section_name",
        "source",
        "subsection_name",
        "type_of_material",
      ],
      optional: true,
    },
    facetFilter: {
      type: "boolean",
      label: "Facet Filter",
      description: "Have facet counts use filters.",
      optional: true,
    },
    fl: {
      type: "string[]",
      label: "Field List",
      description: "The list of fields to return in the result set.",
      optional: true,
    },
    fq: {
      type: "string",
      label: "Filtered Query",
      description: "A query to filter the search results.",
      optional: true,
    },
    q: {
      type: "string",
      label: "Query",
      description: "Search query term. Search is performed on the article body, headline, and byline.",
      optional: true,
    },
    alert: {
      type: "alert",
      alertType: "info",
      content: "To learn more about filters you can download the [New York Times specification here](https://developer.nytimes.com/portals/api/sites/nyt-devportal/liveportal/apis/articlesearch-product/download_spec).",
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || moment().subtract(1, "day");
    },
    _setLastDate(created) {
      this.db.set("lastDate", created);
    },
    generateMeta(item) {
      return {
        id: item._id,
        summary: `A new article was just published with Id: ${item._id}.`,
        ts: item.pub_date,
      };
    },
    async startEvent(maxResults = 0) {
      const lastDate = this._getLastDate();

      const data = this.app.paginate({
        fn: this.app.searchArticles,
        maxResults,
        params: {
          begin_date: moment(lastDate).format("YYYYMMDD"),
          facet: this.facet,
          facet_fields: this.facetFields && this.facetFields.join(),
          facet_filter: this.facetFilter,
          fl: this.fl && this.fl.join(),
          fq: this.fq,
          q: this.q,
          sort: "newest",
        },
      });

      const responseArray = [];
      for await (const item of data) {
        if (Date.parse(item.pub_date) <= Date.parse(lastDate)) break;
        responseArray.push(item);
      }

      if (responseArray.length) this._setLastDate(responseArray[0].pub_date);

      for (const item of responseArray.reverse()) {
        this.$emit(item, this.generateMeta(item));
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
  sampleEmit,
};

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
New York Times	`app`	`app`	This component uses the New York Times app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Facet	`facet`	`boolean`	Whether to show facet counts.
Facet Fields	`facetFields`	`string[]`	Select a value from the drop down menu:`day_of_weekdocument_typeingredientsnews_deskpub_monthpub_yearsection_namesourcesubsection_nametype_of_material`
Facet Filter	`facetFilter`	`boolean`	Have facet counts use filters.
Field List	`fl`	`string[]`	The list of fields to return in the result set.
Filtered Query	`fq`	`string`	A query to filter the search results.
Query	`q`	`string`	Search query term. Search is performed on the article body, headline, and byline.

Trigger Authentication#

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

About New York Times#

The New York Times is an American daily newspaper which features top articles across many sections, including politics, technology, and opinion.

Action#

Create Ticket Field on Freshdesk

Description:Create a ticket field in Freshdesk. [See the documentation](https://developers.freshdesk.com/api/#create_ticket_field)

Version:0.0.1

Key:freshdesk-create-ticket-field

View on GitHub

Freshdesk Overview#

The Freshdesk API empowers you to interact programmatically with your customer support platform, creating possibilities for automating repetitive tasks, integrating with other services, and enhancing customer experiences. With Pipedream, you can effortlessly connect Freshdesk to a multitude of apps, tapping into triggers and actions that streamline workflows. For instance, you can automate ticket creation, sync customer issues with a CRM, or trigger notifications based on ticket updates, all within a serverless environment.

Action Code#

import freshdesk from "../../freshdesk.app.mjs";
import { parseObject } from "../../common/utils.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "freshdesk-create-ticket-field",
  name: "Create Ticket Field",
  description: "Create a ticket field in Freshdesk. [See the documentation](https://developers.freshdesk.com/api/#create_ticket_field)",
  version: "0.0.1",
  type: "action",
  props: {
    freshdesk,
    label: {
      type: "string",
      label: "Label",
      description: "Display the name of the Ticket Field",
    },
    labelForCustomers: {
      type: "string",
      label: "Label for Customers",
      description: "The label for the field as seen by customers",
    },
    type: {
      type: "string",
      label: "Type",
      description: "The type of the field. Can be custom_dropdown, custom_checkbox, custom_text, etc...",
      default: "custom_text",
    },
    customersCanEdit: {
      type: "boolean",
      label: "Customers Can Edit",
      description: "Whether customers can edit the field",
      optional: true,
    },
    displayedToCustomers: {
      type: "boolean",
      label: "Displayed to Customers",
      description: "Whether the field is displayed to customers",
      optional: true,
    },
    position: {
      type: "integer",
      label: "Position",
      description: "The position of the fieldPosition in which the ticket field is displayed in the form. If not given, it will be displayed on top",
      optional: true,
    },
    requiredForClosure: {
      type: "boolean",
      label: "Required for Closure",
      description: "Set to `true` if the field is mandatory for closing the ticket",
      optional: true,
    },
    requiredForAgents: {
      type: "boolean",
      label: "Required for Agents",
      description: "Set to `true` if the field is mandatory for agents",
      optional: true,
    },
    requiredForCustomers: {
      type: "boolean",
      label: "Required for Customers",
      description: "Set to `true` if the field is mandatory for customers",
      optional: true,
    },
    choices: {
      type: "string[]",
      label: "Choices",
      description: "Array of key, value pairs containing the value and position of dropdown choices. Example: `[{ \"value\": \"Refund\", \"position\": 1 }, { \"value\": \"FaultyProduct\", \"position\": 2 }]`",
      optional: true,
    },
    dependentFields: {
      type: "string[]",
      label: "Dependent Fields",
      description: "Applicable only for dependent fields, this contains details of nested fields Example: `[{ \"label\": \"District\", \"label_for_customers\": \"District\", \"level\": 2 }, { \"label\": \"Branch\", \"label_for_customers\": \"Branch\", \"level\": 3 }]`",
      optional: true,
    },
    sectionMappings: {
      type: "string[]",
      label: "Section Mappings",
      description: "Applicable only if the field is part of a section. This contains the details of a section (ID, position) for which it is been a part of. Example: `[{ \"position\": 3, \"section_id\": 1 }]`",
      optional: true,
    },
  },
  async run({ $ }) {
    if (this.type === "custom_dropdown" && !this.choices) {
      throw new ConfigurationError("Choices are required for custom_dropdown fields");
    }

    const response = await this.freshdesk.createTicketField({
      $,
      data: {
        label: this.label,
        customers_can_edit: this.customersCanEdit,
        label_for_customers: this.labelForCustomers,
        displayed_to_customers: this.displayedToCustomers,
        position: this.position,
        type: this.type,
        required_for_closure: this.requiredForClosure,
        required_for_agents: this.requiredForAgents,
        required_for_customers: this.requiredForCustomers,
        choices: parseObject(this.choices),
        dependent_fields: parseObject(this.dependentFields),
        section_mappings: parseObject(this.sectionMappings),
      },
    });
    $.export("$summary", `Successfully created ticket field: ${response.label}`);
    return response;
  },
};

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
Freshdesk	`freshdesk`	`app`	This component uses the Freshdesk app.
Label	`label`	`string`	Display the name of the Ticket Field
Label for Customers	`labelForCustomers`	`string`	The label for the field as seen by customers
Type	`type`	`string`	The type of the field. Can be custom_dropdown, custom_checkbox, custom_text, etc...
Customers Can Edit	`customersCanEdit`	`boolean`	Whether customers can edit the field
Displayed to Customers	`displayedToCustomers`	`boolean`	Whether the field is displayed to customers
Position	`position`	`integer`	The position of the fieldPosition in which the ticket field is displayed in the form. If not given, it will be displayed on top
Required for Closure	`requiredForClosure`	`boolean`	Set to `true` if the field is mandatory for closing the ticket
Required for Agents	`requiredForAgents`	`boolean`	Set to `true` if the field is mandatory for agents
Required for Customers	`requiredForCustomers`	`boolean`	Set to `true` if the field is mandatory for customers
Choices	`choices`	`string[]`	Array of key, value pairs containing the value and position of dropdown choices. Example: `[{ "value": "Refund", "position": 1 }, { "value": "FaultyProduct", "position": 2 }]`
Dependent Fields	`dependentFields`	`string[]`	Applicable only for dependent fields, this contains details of nested fields Example: `[{ "label": "District", "label_for_customers": "District", "level": 2 }, { "label": "Branch", "label_for_customers": "Branch", "level": 3 }]`
Section Mappings	`sectionMappings`	`string[]`	Applicable only if the field is part of a section. This contains the details of a section (ID, position) for which it is been a part of. Example: `[{ "position": 3, "section_id": 1 }]`

Create Ticket Field with Freshdesk API on New Article Published from New York Times API

Pipedream makes it easy to connect APIs for Freshdesk, New York Times and 2,800+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

1
-
24
of
2,800+
apps by most popular