Unsubscribe Email with Firefish API on Ticket Updated (Instant) from Zendesk API

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

Trigger workflow on

Ticket Updated (Instant) from the Zendesk API

Next, do this

Unsubscribe Email with the Firefish 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 Firefish action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Ticket Updated (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 Unsubscribe Email action
1. Connect your Firefish account
2. Configure Email
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 Updated (Instant) on Zendesk

Description:Emit new event when a ticket has been updated

Version:0.2.2

Key:zendesk-ticket-updated

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 Updated (Instant)",
  key: "zendesk-ticket-updated",
  type: "source",
  description: "Emit new event when a ticket has been updated",
  version: "0.2.2",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getWebhookName() {
      return "Ticket Updated Webhook";
    },
    getTriggerTitle() {
      return "Ticket Updated Trigger";
    },
    getTriggerConditions() {
      return {
        all: [
          {
            field: "update_type",
            value: "Change",
          },
        ],
      };
    },
  },
};

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#

Unsubscribe Email on Firefish

Description:Removes a particular contact or candidate from all existing firefish email subscriptions. [See the documentatio](https://developer.firefishsoftware.com/#002bb8c0-0b41-4016-b33c-026a46b499b2)

Version:0.0.1

Key:firefish-unsubscribe-email

View on GitHub

Action Code#

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

export default {
  key: "firefish-unsubscribe-email",
  name: "Unsubscribe Email",
  description: "Removes a particular contact or candidate from all existing firefish email subscriptions. [See the documentatio](https://developer.firefishsoftware.com/#002bb8c0-0b41-4016-b33c-026a46b499b2)",
  version: "0.0.1",
  type: "action",
  props: {
    firefish,
    email: {
      type: "string",
      label: "Email",
      description: "The email address of the subscriber you want to remove",
    },
  },
  async run({ $ }) {
    const contacts = await this.firefish.searchContacts({
      $,
      params: {
        "email-address": this.email,
      },
    });
    for (const contact of contacts) {
      contact.EmailMarketing = false;
      await this.firefish.updateContact({
        $,
        contactId: contact.Ref,
        data: contact,
      });
    }

    const candidates = await this.firefish.searchCandidates({
      $,
      params: {
        "email-address": this.email,
      },
    });
    for (const candidate of candidates) {
      candidate.EmailMarketing = false;
      await this.firefish.updateCandidate({
        $,
        candidateId: candidate.Ref,
        data: candidate,
      });
    }

    $.export("$summary", `Successfully removed ${this.email} from email marketing`);
    return {
      contacts,
      candidates,
    };
  },
};

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
Firefish	`firefish`	`app`	This component uses the Firefish app.
Email	`email`	`string`	The email address of the subscriber you want to remove

Action Authentication#

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

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