← RingCentral + Cliniko integrations

Get Patient with Cliniko API on New Inbound Message Event (Instant) from RingCentral API

Pipedream makes it easy to connect APIs for Cliniko, RingCentral and 2,000+ other apps remarkably fast.

Trigger workflow on
New Inbound Message Event (Instant) from the RingCentral API
Next, do this
Get Patient with the Cliniko API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

This integration creates a workflow with a RingCentral trigger and Cliniko action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Select this integration
  2. Configure the New Inbound Message Event (Instant) trigger
    1. Connect your RingCentral account
    2. Select one or more Extensions
    3. Select a Message Type
  3. Configure the Get Patient action
    1. Connect your Cliniko account
    2. Configure Patient ID
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. 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

Description:Emit new event for each status change of inbound messages of a specific type
Version:0.1.4
Key:ringcentral-new-inbound-message

RingCentral Overview

RingCentral API is a powerful tool that allows users to build applications and
solutions that make communication easier and more convenient. With RingCentral
API, developers can build communication solutions that include voice and video,
SMS/MMS, Fax, and other features.

With RingCentral API, developers can build:

  • Voice and Video calls with advanced interactions, such as ringback tones,
    call screening, call forwarding, call recording and conference calling.
  • Rich messaging applications leveraging SMS, MMS, and chat functionality.
  • Fax solutions, such as sending and receiving faxes through a web application.
  • Presence and availability services, allowing users to set their status and
    view the status of other users.
  • Automated voice solutions such as voice recognition, voice menus and more.
  • Voice analytics and call quality monitoring.
  • Contact center solutions with the ability to monitor and manage queues.

Trigger Code

import common from "../common/http-based.mjs";
import messageTypes from "../common/message-types.mjs";

export default {
  ...common,
  key: "ringcentral-new-inbound-message",
  name: "New Inbound Message Event (Instant)",
  description: "Emit new event for each status change of inbound messages of a specific type",
  version: "0.1.4",
  type: "source",
  props: {
    ...common.props,
    extensionId: {
      propDefinition: [
        common.props.ringcentral,
        "extensionId",
      ],
    },
    messageType: {
      type: "string",
      label: "Message Type",
      description: "The type of message to monitor for status changes",
      options: messageTypes,
    },
  },
  methods: {
    ...common.methods,
    getSupportedNotificationTypes() {
      return new Set([
        "ringcentral-message-event-inbound",
      ]);
    },
    getPropValues() {
      return {
        extensionId: this.extensionId,
        messageType: this.messageType,
      };
    },
    async emitEvent(event) {
      const { body } = event;

      this.$emit(body, {
        id: body.uuid,
        summary: `New inbound message received with ID ${body.uuid}`,
        ts: Date.parse(body.timestamp),
      });
    },
  },
};

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.
LabelPropTypeDescription
RingCentralringcentralappThis component uses the RingCentral app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between executions.
N/Ahttp$.interface.httpThis 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.
ExtensionsextensionIdstring[]Select a value from the drop down menu.
Message TypemessageTypestringSelect a value from the drop down menu:FaxPagerSMSVoicemail

Trigger Authentication

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

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

About RingCentral

Experience Intelligent Phone, Meetings, Contact Center, and AI Solutions with RingCentral, the complete cloud communications platform.

Action

Description:Get the details of a patient by patient ID.
Version:0.0.1
Key:cliniko-get-patient

Cliniko Overview

The Cliniko API allows developers to access content and features from the
Cliniko platform. Using the API, developers can build applications that can do
the following:

  • View and search for patient records
  • View and search for appointments
  • Manage patient files
  • Send SMS and email messages
  • Generate clinical reports
  • And more!

Action Code

const cliniko = require("../../cliniko.app.js");

module.exports = {
  name: "Get Patient",
  key: "cliniko-get-patient",
  description: "Get the details of a patient by patient ID.",
  version: "0.0.1",
  type: "action",
  props: {
    cliniko,
    patientId: {
      propDefinition: [
        cliniko,
        "patientId",
      ],
    },
  },
  async run() {
    return await this.cliniko.getPatient(this.patientId);
  },
};

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.

LabelPropTypeDescription
ClinikoclinikoappThis component uses the Cliniko app.
Patient IDpatientIdinteger

Enter a unique patient ID.

Action Authentication

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

Each Cliniko user will have their own API Key(s) - these are used for authentication. The API Key will have the same permissions as the user it belongs to. See docs.

shard is the Cliniko shard the account resides in. API keys have the shard appended to the end, e.g. MS0xLWl4SzYYYYdtR3V2HNOTAREALKEYwvNHdeW0pd-au2 is in the shard au2

About Cliniko

Health Practice Management Software

More Ways to Connect Cliniko + RingCentral

Get Patient with Cliniko API on Missed Inbound Call (Instant) from Ringcentral API
RingCentral + Cliniko
 
Try it
Get Patient with Cliniko API on New Call Recording from Ringcentral API
RingCentral + Cliniko
 
Try it
Get Patient with Cliniko API on New Event (Instant) from Ringcentral API
RingCentral + Cliniko
 
Try it
Get Patient with Cliniko API on New Inbound Call (Instant) from Ringcentral API
RingCentral + Cliniko
 
Try it
Get Patient with Cliniko API on New Inbound Fax (Instant) from Ringcentral API
RingCentral + Cliniko
 
Try it
New Call Recording from the RingCentral API

Emit new events when a call recording is created

 
Try it
New Event (Instant) from the RingCentral API

Emit new event for each notification from RingCentral of a specified type

 
Try it
New Inbound Call (Instant) from the RingCentral API

Emit new event on each incoming call

 
Try it
New Inbound Fax (Instant) from the RingCentral API

Emit new event on each incoming fax

 
Try it
New Inbound Message Event (Instant) from the RingCentral API

Emit new event for each status change of inbound messages of a specific type

 
Try it
Create Meeting with the RingCentral API

Creates a new meeting. See the API docs here.

 
Try it
Download Recording with the RingCentral API

Gets a recording and downloads it to the /tmp directory. See the documentation

 
Try it
Get Message with the RingCentral API

Get message from the Message Store. See the API docs here

 
Try it
Make CallOut with the RingCentral API

Creates a new outbound call out session. See the API docs here

 
Try it
Send SMS with the RingCentral API

Creates and sends a new text message. See the API docs here

 
Try it

Explore Other Apps

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

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Google Drive
Google Drive
Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.
Google Sheets
Google Sheets
Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.
Filter
Filter
Specify a condition that your workflow must meet and whether you'd like to proceed or end workflow execution.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Data Stores
Data Stores
Use Pipedream Data Stores to manage state throughout your workflows.
GitHub
GitHub
Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.
Formatting
Formatting
Pre-built actions to make formatting and manipulating data within your workflows easier.
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Airtable (OAuth)
Airtable (OAuth)
Airtable is a low-code platform to build next-gen apps. Move beyond rigid tools, operationalize your critical data, and reimagine workflows with AI.
Zoom
Zoom
Zoom is the leader in modern enterprise video communications, with an easy, reliable cloud platform for video and audio conferencing, chat, and webinars.
Google Calendar
Google Calendar
With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.
Gmail
Gmail
Gmail offers private and secure email by Google at no cost, for business and consumer accounts.
Gmail (Developer App)
Gmail (Developer App)
Private and secure email by Google at no cost, for business and consumer accounts. Use this app to connect your own developer account credentials.
Email
Email
Trigger workflows on new emails, and send emails to yourself as part of a Pipedream workflow.
Delay
Delay
Delay, pause, suspend, or have the execution of your workflow wait for as little as one millisecond, or as long as one year.
Go
Go
Anything you can do in Go, you can do in a Pipedream Workflow. You can use any of Go packages available with a simple import.
Premium
Zoom Admin
Zoom Admin
Video conferencing (includes account-level scopes) for Zoom Admins.
Twilio
Twilio
Twilio is a cloud communications platform for building SMS, Voice & Messaging applications on an API built for global scale.
Bash
Bash
Run any Bash in a Pipedream step within your workflow, including making curl requests.