Update Comment with Jira API on New Email Campaign from VBOUT API

Pipedream makes it easy to connect APIs for Jira, VBOUT and 3,000+ other apps remarkably fast.

Trigger workflow on

New Email Campaign from the VBOUT API

Next, do this

Update Comment with the Jira 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 VBOUT trigger and Jira action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Email Campaign trigger
1. Connect your VBOUT account
2. Configure Polling interval
Configure the Update Comment action
1. Connect your Jira account
2. Select a Cloud ID
3. Select a Issue ID or Key
4. Select a Comment ID
5. Optional- Configure Body
6. Optional- Configure Comment
7. Optional- Configure Visibility
8. Optional- Configure Properties
9. Optional- Configure Additional properties
10. Optional- Configure Notify Users
11. Optional- Configure Expand
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 Email Campaign on VBOUT

Description:Emit new event for each new email campaign. [See docs here](https://developers.vbout.com/docs#emailmarketing_campaigns)

Version:0.0.3

Key:vbout-new-email-campaign

View on GitHub

VBOUT Overview#

The VBOUT API unlocks the potential to automate your marketing stack, leveraging Pipedream's capabilities for seamless integrations with other services. With VBOUT, you can manage contacts, automate email campaigns, track user actions, and analyze performance data. Pipedream enhances this by allowing you to capture events in real-time, process data with serverless code, and connect with countless apps to extend your marketing automation workflows.

Trigger Code#

import moment from "moment"; import common from "../common/base.mjs"; export default { ...common, type: "source", name: "New Email Campaign", key: "vbout-new-email-campaign", description: "Emit new event for each new email campaign. [See docs here](https://developers.vbout.com/docs#emailmarketing_campaigns)", version: "0.0.3", dedupe: "unique", props: { ...common.props, }, methods: { ...common.methods, getDataToEmit({ id }) { const ts = new Date().getTime(); return { id, summary: `New Email Campaign (${id})`, ts, }; }, getDatetimeField() { return "creation_date"; }, getItemDate(datetime) { return moment(datetime) .format("YYYY-MM-DD"); }, getLastDate(itemDate) { return moment(itemDate).subtract(1, "day") .format("YYYY-MM-DD"); }, async getRecords(params) { const toEmit = []; const records = this.vbout.paginate({ fn: this.vbout.getCampaigns, params, field: "campaigns", }); for await (const record of records) { toEmit.push(record); } return toEmit; }, async getItems() { const { campaigns } = await this.vbout.getCampaigns({ limit: 20, filter: "all", }); return campaigns; }, getParams({ lastDatetime }) { return { limit: 99999999, filter: "all", from: lastDatetime, }; }, }, };

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
VBOUT	`vbout`	`app`	This component uses the VBOUT app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the vbout API on this schedule

Trigger Authentication#

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

To retrieve your API key,

Navigate to your VBOUT account and sign in
Go to “Settings” > “API Integrations”

About VBOUT#

VBOUT offers several marketing tools into one powerful platform: Social media, landing pages, lead management, email marketing, automation and analytics.

Action#

Update Comment on Jira

Description:Updates a comment. [See the documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments/#api-rest-api-3-issue-issueidorkey-comment-id-put)

Version:0.1.15

Key:jira-update-comment

View on GitHub

Jira Overview#

The Jira API opens up a world of possibilities for automating project management tasks, syncing with other tools, and enhancing data visibility. With Pipedream's integration, you can streamline issue tracking by automatically creating, updating, and searching for issues in Jira, as well as managing projects, sprints, users, and more. This integration not only saves time but also ensures real-time data flow across various platforms, keeping teams in sync and projects on track.

Action Code#

import utils from "../../common/utils.mjs"; import common from "../common/issue.mjs"; import { ConfigurationError } from "@pipedream/platform"; import jira from "../../jira.app.mjs"; export default { key: "jira-update-comment", name: "Update Comment", description: "Updates a comment. [See the documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments/#api-rest-api-3-issue-issueidorkey-comment-id-put)", version: "0.1.15", annotations: { destructiveHint: true, openWorldHint: true, readOnlyHint: false, }, type: "action", props: { jira, cloudId: { propDefinition: [ jira, "cloudId", ], }, issueIdOrKey: { propDefinition: [ jira, "issueIdOrKey", (c) => ({ cloudId: c.cloudId, }), ], }, commentId: { propDefinition: [ jira, "commentId", (c) => ({ cloudId: c.cloudId, issueIdOrKey: c.issueIdOrKey, }), ], }, body: { type: "object", label: "Body", description: "The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/), e.g. `{\"type\":\"doc\",\"version\":1,\"content\":[{\"content\":[{\"text\":\"This is a comment\",\"type\":\"text\"}],\"type\":\"paragraph\"}]}`. Will overwrite comment if both comment and body are provided", optional: true, }, comment: { type: "string", label: "Comment", description: "The comment text", optional: true, }, visibility: { type: "object", label: "Visibility", description: "The group or role to which this comment is visible, See `Visibility` section of [doc](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments/#api-rest-api-3-issue-issueidorkey-comment-id-put)", optional: true, }, properties: { propDefinition: [ jira, "properties", ], description: "Details of issue properties to be added or updated. Please provide an array of objects with keys and values.", }, additionalProperties: { propDefinition: [ jira, "additionalProperties", ], }, notifyUsers: { type: "boolean", label: "Notify Users", description: "Whether users are notified when a comment is updated", optional: true, }, expand: { propDefinition: [ jira, "expand", ], description: "Use expand to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.", }, }, async run({ $ }) { if (!this.comment && !this.body) { throw new ConfigurationError("Either comment or body is required"); } const body = this.body ? utils.parseObject(this.body) : this.comment ? common.methods.atlassianDocumentFormat(this.comment) : undefined; const visibility = utils.parseObject(this.visibility); const additionalProperties = utils.parseObject(this.additionalProperties); let properties; try { properties = JSON.parse(this.properties); } catch ( err ) { //pass } const response = await this.jira.updateComment({ $, cloudId: this.cloudId, issueIdOrKey: this.issueIdOrKey, commentId: this.commentId, params: { notifyUsers: this.notifyUsers, expand: this.expand, }, data: { body, visibility, properties, ...additionalProperties, }, }); $.export("$summary", `Comment with ID: ${this.commentId} has been updated for the issue with ID(or key): ${this.issueIdOrKey}`); 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
Jira	`jira`	`app`	This component uses the Jira app.
Cloud ID	`cloudId`	`string`	Select a value from the drop down menu.
Issue ID or Key	`issueIdOrKey`	`string`	Select a value from the drop down menu.
Comment ID	`commentId`	`string`	Select a value from the drop down menu.
Body	`body`	`object`	The comment text in Atlassian Document Format, e.g. `{"type":"doc","version":1,"content":[{"content":[{"text":"This is a comment","type":"text"}],"type":"paragraph"}]}`. Will overwrite comment if both comment and body are provided
Comment	`comment`	`string`	The comment text
Visibility	`visibility`	`object`	The group or role to which this comment is visible, See `Visibility` section of doc
Properties	`properties`	`string`	Details of issue properties to be added or updated. Please provide an array of objects with keys and values.
Additional properties	`additionalProperties`	`object`	Extra properties of any type may be provided to this object
Notify Users	`notifyUsers`	`boolean`	Whether users are notified when a comment is updated
Expand	`expand`	`string`	Use expand to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.

Action Authentication#

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

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

read:jira-workmanage:jira-projectread:jira-userwrite:jira-workmanage:jira-data-providerread:meoffline_accessread:issue-details:jiraread:board-scope:jira-softwareread:webhook:jirawrite:webhook:jiraread:field:jiraread:project:jiradelete:webhook:jirawrite:board-scope:jira-softwareread:board-scope.admin:jira-softwareread:sprint:jira-softwarewrite:sprint:jira-softwareread:field.option:jirawrite:field.option:jiraread:custom-field-contextual-configuration:jira write:custom-field-contextual-configuration:jiramanage:jira-configurationread:jql:jira

Update Comment with Jira API on New Email Campaign from VBOUT API

Pipedream makes it easy to connect APIs for Jira, VBOUT and 3,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

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