Create Affiliate Lead with Relavate API on Ticket Solved (Instant) from Zendesk API

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

Trigger workflow on

Ticket Solved (Instant) from the Zendesk API

Next, do this

Create Affiliate Lead with the Relavate 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 Relavate 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 Create Affiliate Lead action
1. Connect your Relavate account
2. Select a Campaign ID
3. Select a Status
4. Configure Client
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#

Create Affiliate Lead on Relavate

Description:This component enables you to create a new affiliate lead for marketing. [See the documentation](https://api.relavate.co/#2a307851-9d54-42ea-9f54-3fb600b152a5)

Version:0.0.1

Key:relavate-create-affiliate-lead

View on GitHub

Relavate Overview#

The Relavate API provides tools for managing customer relations and sales efforts, enabling users to automate and optimize their CRM activities. With capabilities for managing contacts, companies, deals, and tasks, the API can serve as a backbone for CRM automation, enhancing customer interaction and business processes efficiency. On Pipedream, you can leverage these functionalities to create advanced workflows, integrate with other apps, and automate tasks based on events from the Relavate system or external triggers.

Action Code#

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

export default {
  key: "relavate-create-affiliate-lead",
  name: "Create Affiliate Lead",
  description: "This component enables you to create a new affiliate lead for marketing. [See the documentation](https://api.relavate.co/#2a307851-9d54-42ea-9f54-3fb600b152a5)",
  version: "0.0.1",
  type: "action",
  props: {
    relavate,
    campaignId: {
      propDefinition: [
        relavate,
        "campaignId",
      ],
      reloadProps: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "The status of the lead being created",
      options: [
        "Pending",
        "Won",
      ],
    },
    client: {
      type: "string",
      label: "Client",
      description: "The company or name of the client",
    },
  },
  async additionalProps() {
    const props = {};
    const partnerType = this.relavate.getPartnerType();
    if (partnerType === "partner") {
      props.vendorId = {
        type: "string",
        label: "Vendor ID",
        description: "The ID of the vendor",
        options: async () => await this.getVendorIdPropOptions(),
      };
    }
    if (partnerType === "vendor") {
      props.partnerId = {
        type: "string",
        label: "Partner ID",
        description: "The ID of the partner",
        options: async () => await this.getPartnerIdPropOptions(),
      };
    }
    return props;
  },
  methods: {
    async getVendorIdPropOptions() {
      const vendors = await this.relavate.listVendors();
      const vendorIds = vendors?.map(({ vendorID }) => vendorID );
      const options = [];
      for (const vendorId of vendorIds) {
        const { name } = await this.relavate.getVendor({
          vendorId,
        });
        options.push({
          value: vendorId,
          label: name,
        });
      }
      return options;
    },
    async getPartnerIdPropOptions() {
      const partners = await this.relavate.listPartners();
      const partnerIds = partners?.map(({ partnerID }) => partnerID );
      const options = [];
      for (const partnerId of partnerIds) {
        const { name } = await this.relavate.getPartner({
          partnerId,
        });
        options.push({
          value: partnerId,
          label: name,
        });
      }
      return options;
    },
  },
  async run({ $ }) {
    const response = await this.relavate.createAffiliateLead({
      $,
      params: {
        campaignID: this.campaignId,
        client: this.client,
        status: this.status,
        vendorID: this.vendorId,
        partnerID: this.partnerId,
      },
    });
    $.export("$summary", `Created affiliate lead with ID: ${response.id}`);
    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
Relavate	`relavate`	`app`	This component uses the Relavate app.
Campaign ID	`campaignId`	`string`	Select a value from the drop down menu.
Status	`status`	`string`	Select a value from the drop down menu:`PendingWon`
Client	`client`	`string`	The company or name of the client

Action Authentication#

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

To retrieve your API Key, API Secret, and Partner Type,