← Vitally

Create Message with Vitally API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Message with the Vitally API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 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

Create a workflow to Create Message with the Vitally API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Create Message action
    1. Connect your Vitally account
    2. Select a Organization Id
    3. Select a Conversation Id
    4. Configure External Id
    5. Optional- Configure Timestamp
    6. Configure Message
    7. Select a From
    8. Select one or more To
    9. Optional- Select one or more CC
    10. Optional- Select one or more BCC
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create Message with Vitally API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Vitally
 
Try it
Create Message with Vitally API on New Submission from Typeform API
Typeform + Vitally
 
Try it
Create Message with Vitally API on Custom Events from Zoom API
Zoom + Vitally
 
Try it
Create Message with Vitally API on New Submission (Instant) from Jotform API
Jotform + Vitally
 
Try it
Create Message with Vitally API on New Scheduled Tasks from Pipedream API
Pipedream + Vitally
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Create Message on Vitally
Description:Create a new message. [See the documentation](https://docs.vitally.io/pushing-data-to-vitally/rest-api/messages#create-a-message-post)
Version:0.0.2
Key:vitally-create-message

Code

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

export default {
  key: "vitally-create-message",
  name: "Create Message",
  version: "0.0.2",
  description: "Create a new message. [See the documentation](https://docs.vitally.io/pushing-data-to-vitally/rest-api/messages#create-a-message-post)",
  type: "action",
  props: {
    vitally,
    organizationId: {
      propDefinition: [
        vitally,
        "organizationId",
      ],
    },
    conversationId: {
      propDefinition: [
        vitally,
        "conversationId",
        ({ organizationId }) => ({
          organizationId,
        }),
      ],
    },
    externalId: {
      propDefinition: [
        vitally,
        "externalId",
      ],
      description: "The unique ID of the message in your system.",
    },
    timestamp: {
      type: "string",
      label: "Timestamp",
      description: "The ISO-formatted string timestamp of when the message was sent.",
      optional: true,
    },
    message: {
      type: "string",
      label: "Message",
      description: "The HTML content of the message.",
    },
    from: {
      propDefinition: [
        vitally,
        "assignedToId",
        ({ organizationId }) => ({
          organizationId,
        }),
      ],
      label: "From",
      description: "The sender participant.",
    },
    to: {
      propDefinition: [
        vitally,
        "assignedToId",
      ],
      type: "string[]",
      label: "To",
      description: "List of the recipient participants.",
    },
    cc: {
      propDefinition: [
        vitally,
        "assignedToId",
      ],
      type: "string[]",
      label: "CC",
      description: "List of the cc recipient participants.",
      optional: true,
    },
    bcc: {
      propDefinition: [
        vitally,
        "assignedToId",
      ],
      type: "string[]",
      label: "BCC",
      description: "List of the bcc recipient participants.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      vitally,
      organizationId,
      conversationId,
      from,
      to,
      cc,
      bcc,
      ...data
    } = this;

    const response = await vitally.createMessage({
      $,
      organizationId,
      conversationId,
      data: {
        ...data,
        from: {
          type: "user",
          id: from,
        },
        to: to && to.map((id) => ({
          type: "user",
          id,
        })),
        cc: cc && cc.map((id) => ({
          type: "user",
          id,
        })),
        bcc: bcc && bcc.map((id) => ({
          type: "user",
          id,
        })),
      },
    });

    $.export("$summary", `A new message with Id: ${response.id} was successfully created!`);
    return response;
  },
};

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
VitallyvitallyappThis component uses the Vitally app.
Organization IdorganizationIdstringSelect a value from the drop down menu.
Conversation IdconversationIdstringSelect a value from the drop down menu.
External IdexternalIdstring

The unique ID of the message in your system.

Timestamptimestampstring

The ISO-formatted string timestamp of when the message was sent.

Messagemessagestring

The HTML content of the message.

FromfromstringSelect a value from the drop down menu.
Totostring[]Select a value from the drop down menu.
CCccstring[]Select a value from the drop down menu.
BCCbccstring[]Select a value from the drop down menu.

Authentication

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

To retrieve your API Key,

  • Click the drop down on the top left with Vitally logo
  • Go to “Settings” > “Integrations” > Vitally REST API
  • Copy the API Key under Secret Token
    Integrations

About Vitally

Modern #CustomerSuccess for B2B SaaS. 🚀 Unify your data, understand it deeply, and build powerful automation to drive a world-class customer experience.

More Ways to Use Vitally

Triggers

New User Created from the Vitally API

Emit new event when a new user is created.

 
Try it

Actions

Create Note with the Vitally API

Create a new note. See the documentation

 
Try it
Create Task with the Vitally API

Create a new task. See the documentation

 
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
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.
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.
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.
Premium
Salesforce (REST API)
Salesforce (REST API)
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
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.
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.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.