AI Data Extraction with Scrapfly API on Ticket Solved (Instant) from Zendesk API

Pipedream makes it easy to connect APIs for Scrapfly, Zendesk and 2,400+ other apps remarkably fast.

Trigger workflow on

Ticket Solved (Instant) from the Zendesk API

Next, do this

AI Data Extraction with the Scrapfly 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 Zendesk trigger and Scrapfly action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Ticket Solved (Instant) trigger
1. Connect your Zendesk account
2. Select a Trigger Category ID
3. Optional- Configure Custom Subdomain
4. Optional- Select one or more Fields
5. Optional- Configure JSON Body
Configure the AI Data Extraction action
1. Connect your Scrapfly account
2. Configure Body
3. Select a Content Type
4. Configure URL
5. Optional- Configure Charset
6. Optional- Configure Extraction Template
7. Optional- Configure Extraction Prompt
8. Optional- Configure Extraction Model
9. Optional- Configure Webhook Name
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#

Ticket Solved (Instant) on Zendesk

Description:Emit new event when a ticket has changed to solved status

Version:0.2.2

Key:zendesk-ticket-solved

View on GitHub

Zendesk Overview#

The Zendesk API enables seamless integration of Zendesk's customer service platform with your existing business processes and third-party applications. By leveraging this API with Pipedream, you can automate ticket tracking, sync customer data, escalate issues, and streamline communication across multiple channels. This can significantly increase efficiency, accelerate response times, and enhance the overall customer experience. Automations can range from simple notifications to complex workflows involving data transformation and multi-step actions across various services.

Trigger Code#

import common from "../common/ticket.mjs";

export default {
  ...common,
  name: "Ticket Solved (Instant)",
  key: "zendesk-ticket-solved",
  type: "source",
  description: "Emit new event when a ticket has changed to solved status",
  version: "0.2.2",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getWebhookName() {
      return "Ticket Solved Webhook";
    },
    getTriggerTitle() {
      return "Ticket Solved Trigger";
    },
    getTriggerConditions() {
      return {
        all: [
          {
            field: "update_type",
            value: "Change",
          },
          {
            field: "status",
            operator: "value",
            value: "solved",
          },
        ],
      };
    },
  },
};

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
Zendesk	`app`	`app`	This component uses the Zendesk app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.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.
Trigger Category ID	`categoryId`	`string`	Select a value from the drop down menu.
Custom Subdomain	`customSubdomain`	`string`	For Enterprise Zendesk accounts: optionally specify the subdomain to use. This will override the subdomain that was provided when connecting your Zendesk account to Pipedream. For example, if you Zendesk URL is https://examplehelp.zendesk.com, your subdomain is `examplehelp`
Fields	`fields`	`string[]`	Select a value from the drop down menu.
JSON Body	`jsonBody`	`string`	Custom JSON Body of the incoming payload. Setting `jsonBody` will overwrite the `fields` prop

Trigger Authentication#

Zendesk uses OAuth authentication. When you connect your Zendesk account, Pipedream will open a popup window where you can sign into Zendesk and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Zendesk API.

Pipedream requests the following authorization scopes when you connect your account:

triggers:writewebhooks:writereadtickets:writetickets:readusers:writeorganizations:readorganizations:write

About Zendesk#

Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.

Action#

AI Data Extraction on Scrapfly

Description:Automate content extraction from any text-based source using AI, LLM, and custom parsing. [See the documentation](https://scrapfly.io/docs/extraction-api/getting-started)

Version:0.0.1

Key:scrapfly-ai-data-extraction

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import fs from "fs";
import { checkTmp } from "../../common/utils.mjs";
import scrapfly from "../../scrapfly.app.mjs";

export default {
  key: "scrapfly-ai-data-extraction",
  name: "AI Data Extraction",
  description: "Automate content extraction from any text-based source using AI, LLM, and custom parsing. [See the documentation](https://scrapfly.io/docs/extraction-api/getting-started)",
  version: "0.0.1",
  type: "action",
  props: {
    scrapfly,
    body: {
      propDefinition: [
        scrapfly,
        "body",
      ],
    },
    contentType: {
      propDefinition: [
        scrapfly,
        "contentType",
      ],
    },
    url: {
      propDefinition: [
        scrapfly,
        "url",
      ],
    },
    charset: {
      type: "string",
      label: "Charset",
      description: "Charset of the document pass in the body. If you are not sure, you can use the `auto` value and we will try to detect it. Bad charset can lead to bad extraction, so it's important to set it correctly. **The most common charset is `utf-8` for text document and `ascii` for binary**. The symptom of a bad charset is that the text is not correctly displayed (accent, special characters, etc).",
      default: "auto",
      optional: true,
    },
    extractionTemplate: {
      type: "string",
      label: "Extraction Template",
      description: "Define an extraction template to get structured data. Use an ephemeral template (declared on the fly on the API call) or a stored template (declared in the dashboard) by using the template name.",
      optional: true,
    },
    extractionPrompt: {
      type: "string",
      label: "Extraction Prompt",
      description: "Instruction to extract data or ask a question on the scraped content with an LLM (Large Language Model). [Must be url encoded](https://scrapfly.io/web-scraping-tools/urlencode).",
      optional: true,
    },
    extractionModel: {
      type: "string",
      label: "Extraction Model",
      description: "AI Extraction to auto parse document to get structured data. E.g., `product`, `review`, `real-estate`, `article`.",
      optional: true,
    },
    webhookName: {
      type: "string",
      label: "Webhook Name",
      description: "Queue you scrape request and redirect API response to a provided webhook endpoint. You can create a webhook endpoint from your `dashboard`, it takes the name of the webhook. Webhooks are scoped to the given project/env.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.extractionTemplate && !this.extractionPrompt && !this.extractionModel) {
      throw new ConfigurationError("You must provide at least **Extraction Template**, **Extraction Prompt** or **Extraction Model**");
    }
    const response = await this.scrapfly.automateContentExtraction({
      $,
      headers: {
        "content-type": this.contentType,
      },
      maxBodyLength: Infinity,
      params: {
        url: this.url,
        charset: this.charset,
        extraction_template: this.extractionTemplate,
        extraction_prompt: this.extractionPrompt,
        extraction_model: this.extractionModel,
        webhook_name: this.webhookName,
      },
      data: fs.readFileSync(checkTmp(this.body)).toString(),
    });

    $.export("$summary", "Successfully extracted content");
    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
Scrapfly	`scrapfly`	`app`	This component uses the Scrapfly app.
Body	`body`	`string`	The request body must contain the content of the page you want to extract data from. The content must be in the format specified by the `content-type` header or via the `content_type` HTTP parameter. Provide a file from `/tmp`. To upload a file to `/tmp` folder, please follow the doc here
Content Type	`contentType`	`string`	Select a value from the drop down menu:`application/jsonapplication/jsonldapplication/xmltext/plaintext/htmltext/markdowntext/csvapplication/xhtml+xml`
URL	`url`	`string`	This URL is used to transform any relative URLs in the document into absolute URLs automatically. It can be either the base URL or the exact URL of the document. Must be url encoded.
Charset	`charset`	`string`	Charset of the document pass in the body. If you are not sure, you can use the `auto` value and we will try to detect it. Bad charset can lead to bad extraction, so it's important to set it correctly. The most common charset is `utf-8` for text document and `ascii` for binary. The symptom of a bad charset is that the text is not correctly displayed (accent, special characters, etc).
Extraction Template	`extractionTemplate`	`string`	Define an extraction template to get structured data. Use an ephemeral template (declared on the fly on the API call) or a stored template (declared in the dashboard) by using the template name.
Extraction Prompt	`extractionPrompt`	`string`	Instruction to extract data or ask a question on the scraped content with an LLM (Large Language Model). Must be url encoded.
Extraction Model	`extractionModel`	`string`	AI Extraction to auto parse document to get structured data. E.g., `product`, `review`, `real-estate`, `article`.
Webhook Name	`webhookName`	`string`	Queue you scrape request and redirect API response to a provided webhook endpoint. You can create a webhook endpoint from your `dashboard`, it takes the name of the webhook. Webhooks are scoped to the given project/env.

AI Data Extraction with Scrapfly API on Ticket Solved (Instant) from Zendesk API

Pipedream makes it easy to connect APIs for Scrapfly, Zendesk and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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