Send Message with Quriiri API on New Ticket (Instant) from Zendesk API

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

Trigger workflow on

New Ticket (Instant) from the Zendesk API

Next, do this

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

Select this integration
Configure the New Ticket (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 Send Message action
1. Connect your Quriiri account
2. Optional- Configure Sender
3. Optional- Select a Sender Type
4. Configure Destination
5. Optional- Configure Text
6. Optional- Configure Data
7. Optional- Configure UDH
8. Optional- Configure Batch ID
9. Optional- Configure Billing Reference
10. Optional- Configure Delivery Receipt URL
11. Optional- Select a Delivery Receipt Type
12. Optional- Configure Flash
13. Optional- Configure Validity
14. Optional- Configure Schedule Time
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 Ticket (Instant) on Zendesk

Description:Emit new event when a ticket is created

Version:0.2.2

Key:zendesk-new-ticket

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

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#

Send Message on Quriiri

Description:Sends an SMS message using the Quriiri API. [See the documentation](https://docs.quriiri.fi/docs/quriiri/send-sms/operations/create-a)

Version:0.0.1

Key:quriiri-send-message

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import {
  DR_TYPE_OPTIONS,
  SENDER_TYPE_OPTIONS,
} from "../../common/constants.mjs";
import quriiri from "../../quriiri.app.mjs";

export default {
  key: "quriiri-send-message",
  name: "Send Message",
  description: "Sends an SMS message using the Quriiri API. [See the documentation](https://docs.quriiri.fi/docs/quriiri/send-sms/operations/create-a)",
  version: "0.0.1",
  type: "action",
  props: {
    quriiri,
    sender: {
      type: "string",
      label: "Sender",
      description: "Message sender. International numbers with + or 00 prefix and 5 to 15 numbers following it, national ones / shortcodes with 1 to 15 numbers, alphanumeric with max 11 characters. Although other characters may work, we cannot guarantee it and recommend restricting the characters used in alphanumeric senders to letters A-Z and a-z, and digits 0-9.",
      optional: true,
    },
    senderType: {
      type: "string",
      label: "Sender Type",
      description: "Sender type. If missing, an attempt is made to guess one from the sender, and guess failure results in an error.",
      options: SENDER_TYPE_OPTIONS,
      optional: true,
    },
    destination: {
      type: "string",
      label: "Destination",
      description: "Message destination number in international or national format. International numbers should begin with + or 00 prefix and national format numbers will be converted to Finnish ones. For maximum reliability, we recommend using only international format numbers, with nothing but digits following the international prefix. The HTTP response contains information about which international number each accepted destination was converted to or treated as. Accepts multiple values array in JSON, set multiple times with form POST and GET.",
    },
    text: {
      type: "string",
      label: "Text",
      description: "Message text. Based on the text, the service automatically determines whether the message can be sent using the GSM character set or if sending it as Unicode is required. Also, the service determines automatically how many SMS messages sending the message will require. The general rule of thumb is that the first SMS using the GSM character set can hold up to 160 characters; if there are more, concatenation is required and each SMS (including the first one) can hold up to 153 characters. Note that some characters in the GSM character set will consume two characters instead of one. For Unicode, the corresponding numbers are 70 and 67. If text is provided, data is ignored. Message templates can be used by finding the template ID from the UI and using {template_ID} placeholder, e.g. \"Hello ${template_361}!\"",
      optional: true,
    },
    data: {
      type: "string",
      label: "Data",
      description: "Binary message data, bytes encoded as hexadecimal characters. If text is provided, data is ignored. Maximum number of bytes in udh and data combined is 140.",
      optional: true,
    },
    udh: {
      type: "string",
      label: "UDH",
      description: "User data header, bytes encoded as hexadecimal characters. Maximum number of bytes in udh and data combined is 140. Note that concatenated text messages may be sent using the entire message context in the text parameter, without setting udh, and the service will take care of splitting the message into appropriately sized parts.",
      optional: true,
    },
    batchId: {
      type: "string",
      label: "Batch ID",
      description: "Batch ID, max 255 characters. Used to group interrelated messages, for example if some special actions should be taken to a group of separately sent but logically related messages. Under normal circumstances, the service does not use this parameter but just relays it back in corresponding delivery reports.",
      optional: true,
    },
    billingRef: {
      type: "string",
      label: "Billing Reference",
      description: "Billing reference, max 255 characters. This is solely for the API user, the service does not do anything else with it besides relaying it back in corresponding delivery reports.",
      optional: true,
    },
    drUrl: {
      type: "string",
      label: "Delivery Receipt URL",
      description: "Delivery report URL. URL where to relay delivery reports",
      optional: true,
    },
    drType: {
      type: "string",
      label: "Delivery Receipt Type",
      description: "Delivery report type. Similarly as for supported API request types. Defaults to the format of the API request.",
      options: DR_TYPE_OPTIONS,
      optional: true,
    },
    flash: {
      type: "boolean",
      label: "Flash",
      description: "Send a \"flash\" SMS if set to true.",
      optional: true,
    },
    validity: {
      type: "integer",
      label: "Validity",
      description: "Validity period of the message in minutes. If not set, defaults to the value set in your account details.",
      min: 1,
      max: 32767,
      optional: true,
    },
    scheduleTime: {
      type: "string",
      label: "Schedule Time",
      description: "Schedule time can be used for message scheduling. If a message is scheduled, the API response contains messageid for later message cancellation, if needed. Schedule time must be set in `RFC 3339` format, ie. `2020-05-31T04:20:03Z`. In scheduling the seconds and milliseconds are ignored, so every scheduled message is sent in a resolution of minutes.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.text && !this.data) {
      throw new ConfigurationError("You must provide either 'Data' or 'Text' input.");
    }
    const response = await this.quriiri.sendSms({
      $,
      data: {
        sender: this.sender,
        destinations: this.destination,
        text: this.text,
        sendertype: this.senderType,
        data: this.data,
        udh: this.udh,
        batchid: this.batchId,
        billingref: this.billingRef,
        drurl: this.drUrl,
        drtype: this.drType,
        flash: this.flash,
        validity: this.validity,
        scheduletime: this.scheduleTime,
      },
    });
    $.export("$summary", `Message sent successfully to ${this.destination}`);
    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
Quriiri	`quriiri`	`app`	This component uses the Quriiri app.
Sender	`sender`	`string`	Message sender. International numbers with + or 00 prefix and 5 to 15 numbers following it, national ones / shortcodes with 1 to 15 numbers, alphanumeric with max 11 characters. Although other characters may work, we cannot guarantee it and recommend restricting the characters used in alphanumeric senders to letters A-Z and a-z, and digits 0-9.
Sender Type	`senderType`	`string`	Select a value from the drop down menu:`{ "label": "International Number", "value": "MSISDN" }{ "label": "National Number / Shortcode", "value": "NATIONAL" }{ "label": "alphanumeric", "value": "ALNUM" }`
Destination	`destination`	`string`	Message destination number in international or national format. International numbers should begin with + or 00 prefix and national format numbers will be converted to Finnish ones. For maximum reliability, we recommend using only international format numbers, with nothing but digits following the international prefix. The HTTP response contains information about which international number each accepted destination was converted to or treated as. Accepts multiple values array in JSON, set multiple times with form POST and GET.
Text	`text`	`string`	Message text. Based on the text, the service automatically determines whether the message can be sent using the GSM character set or if sending it as Unicode is required. Also, the service determines automatically how many SMS messages sending the message will require. The general rule of thumb is that the first SMS using the GSM character set can hold up to 160 characters; if there are more, concatenation is required and each SMS (including the first one) can hold up to 153 characters. Note that some characters in the GSM character set will consume two characters instead of one. For Unicode, the corresponding numbers are 70 and 67. If text is provided, data is ignored. Message templates can be used by finding the template ID from the UI and using {template_ID} placeholder, e.g. "Hello ${template_361}!"
Data	`data`	`string`	Binary message data, bytes encoded as hexadecimal characters. If text is provided, data is ignored. Maximum number of bytes in udh and data combined is 140.
UDH	`udh`	`string`	User data header, bytes encoded as hexadecimal characters. Maximum number of bytes in udh and data combined is 140. Note that concatenated text messages may be sent using the entire message context in the text parameter, without setting udh, and the service will take care of splitting the message into appropriately sized parts.
Batch ID	`batchId`	`string`	Batch ID, max 255 characters. Used to group interrelated messages, for example if some special actions should be taken to a group of separately sent but logically related messages. Under normal circumstances, the service does not use this parameter but just relays it back in corresponding delivery reports.
Billing Reference	`billingRef`	`string`	Billing reference, max 255 characters. This is solely for the API user, the service does not do anything else with it besides relaying it back in corresponding delivery reports.
Delivery Receipt URL	`drUrl`	`string`	Delivery report URL. URL where to relay delivery reports
Delivery Receipt Type	`drType`	`string`	Select a value from the drop down menu:`JSONPOSTGET`
Flash	`flash`	`boolean`	Send a "flash" SMS if set to true.
Validity	`validity`	`integer`	Validity period of the message in minutes. If not set, defaults to the value set in your account details.
Schedule Time	`scheduleTime`	`string`	Schedule time can be used for message scheduling. If a message is scheduled, the API response contains messageid for later message cancellation, if needed. Schedule time must be set in `RFC 3339` format, ie. `2020-05-31T04:20:03Z`. In scheduling the seconds and milliseconds are ignored, so every scheduled message is sent in a resolution of minutes.

Action Authentication#

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

To retrieve your API Key and API URL,