Skip to content

Commit 3b30a33

Browse files
deusdetemichelle0927vunguyenhung
authored
Codeqr new actions (#17060)
* Implement CodeQR API integration with actions for link and QR code management * Add dependencies for amazon_redshift and codeqr components * updates * pnpm-lock.yaml * pnpm-lock.yaml * chore: update version numbers and remove unused props in Create a CodeQR Link action * feat: update Create a QR Code action with new properties and version bump * chore: bump version to 0.1.2 in package.json * updates * feat: remove tagNames property from Create Link action --------- Co-authored-by: Michelle Bergeron <[email protected]> Co-authored-by: Leo Vu <[email protected]>
1 parent 424d1f6 commit 3b30a33

File tree

11 files changed

+718
-7
lines changed

11 files changed

+718
-7
lines changed

‎components/codeqr/README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Overview
2+
3+
The CodeQR API enables you to create and manage dynamic QR Codes, shorten URLs, capture leads, and track engagement through powerful analytics. By integrating CodeQR with Pipedream, you can automate the generation of QR Codes and short links across a wide range of workflows — from marketing automation to customer support — and seamlessly connect these actions to over 2,500 apps. fileciteturn3file0
4+
5+
# Example Use Cases
6+
7+
- **Dynamic QR Code Generation for Marketing Campaigns**
8+
Automatically generate campaign-specific QR Codes when a new campaign is launched in your CRM or marketing tool. Store the QR code image in your cloud drive (e.g., Google Drive or Dropbox), and attach it to your newsletters or printed materials.
9+
10+
- **URL Shortening with Pre-Redirect Lead Capture**
11+
When a new record is added to Airtable or a Google Sheet with a destination URL, create a short link using CodeQR that optionally includes a lead capture page before redirection. Use this to qualify traffic before they reach your landing page.
12+
13+
- **Automated Feedback Collection**
14+
Trigger the creation of a QR code linked to a feedback form after each customer interaction in platforms like Zendesk, Intercom, or HubSpot. Easily track which customers scanned the code and filled the form, and centralize the responses.
15+
16+
- **Analytics Monitoring and Reporting**
17+
Use Pipedream workflows to pull scan and click analytics from CodeQR at regular intervals. Send the data to Slack, update a Google Sheet, or visualize trends on a custom dashboard.

‎components/codeqr/actions/create-link/create-link.mjs‎

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
import codeqr from "../../codeqr.app.mjs";
2+
3+
export default {
4+
key: "codeqr-create-link",
5+
name: "Create a CodeQR Link",
6+
description:
7+
"Creates a short link in CodeQR using the CodeQR API. [See the documentation](https://codeqr.mintlify.app/api-reference/endpoint/create-a-link)",
8+
version: "0.0.1",
9+
type: "action",
10+
props: {
11+
codeqr,
12+
url: {
13+
type: "string",
14+
label: "URL",
15+
description: "The destination URL of the short link.",
16+
},
17+
key: {
18+
type: "string",
19+
label: "Key",
20+
description:
21+
"The short link slug. If not provided, a random 7-character slug will be generated.",
22+
optional: true,
23+
},
24+
domain: {
25+
type: "string",
26+
label: "Domain",
27+
description:
28+
"The domain of the short link. If not provided, the default workspace domain will be used.",
29+
optional: true,
30+
},
31+
externalId: {
32+
type: "string",
33+
label: "External ID",
34+
description:
35+
"This is the ID of the link in your database. Must be prefixed with ext_.",
36+
optional: true,
37+
},
38+
password: {
39+
type: "string",
40+
label: "Password",
41+
description: "The password required to access the destination URL.",
42+
optional: true,
43+
},
44+
flexible: {
45+
type: "boolean",
46+
label: "Flexible Link",
47+
description:
48+
"Whether this is a flexible link with dynamic destination setting.",
49+
optional: true,
50+
},
51+
title: {
52+
type: "string",
53+
label: "Title",
54+
description: "The title displayed on the short link page.",
55+
optional: true,
56+
},
57+
description: {
58+
type: "string",
59+
label: "Description",
60+
description: "A description displayed on the short link page.",
61+
optional: true,
62+
},
63+
image: {
64+
type: "string",
65+
label: "Image URL",
66+
description: "URL of the image displayed on the short link page.",
67+
optional: true,
68+
},
69+
video: {
70+
type: "string",
71+
label: "Video URL",
72+
description: "URL of the video displayed on the short link page.",
73+
optional: true,
74+
},
75+
proxy: {
76+
type: "boolean",
77+
label: "Proxy",
78+
description: "Enable proxy settings.",
79+
optional: true,
80+
},
81+
rewrite: {
82+
type: "boolean",
83+
label: "Rewrite Link",
84+
description: "Enable link rewriting.",
85+
optional: true,
86+
},
87+
ios: {
88+
type: "string",
89+
label: "iOS URL",
90+
description: "The iOS destination URL for device-specific redirection.",
91+
optional: true,
92+
},
93+
android: {
94+
type: "string",
95+
label: "Android URL",
96+
description:
97+
"The Android destination URL for device-specific redirection.",
98+
optional: true,
99+
},
100+
doIndex: {
101+
type: "boolean",
102+
label: "Allow Indexing",
103+
description: "Enable indexing of the short link.",
104+
optional: true,
105+
},
106+
comments: {
107+
type: "string",
108+
label: "Comments",
109+
description: "Comments or notes about the short link.",
110+
optional: true,
111+
},
112+
expiresAt: {
113+
type: "string",
114+
label: "Expiration Date",
115+
description:
116+
"The date and time when the short link will expire (ISO 8601). E.g. `2025-06-13T05:31:56Z`",
117+
optional: true,
118+
},
119+
expiredUrl: {
120+
type: "string",
121+
label: "Expired Redirect URL",
122+
description: "The URL to redirect to when the short link has expired.",
123+
optional: true,
124+
},
125+
geo: {
126+
type: "object",
127+
label: "Geo-Targeting",
128+
description:
129+
"Mapping of country codes to destination URLs (JSON format).",
130+
optional: true,
131+
},
132+
publicStats: {
133+
type: "boolean",
134+
label: "Public Stats",
135+
description: "Whether the short link's stats are publicly accessible.",
136+
optional: true,
137+
},
138+
},
139+
140+
async run({ $ }) {
141+
const {
142+
url,
143+
key,
144+
domain,
145+
externalId,
146+
password,
147+
flexible,
148+
title,
149+
description,
150+
image,
151+
video,
152+
proxy,
153+
rewrite,
154+
ios,
155+
android,
156+
doIndex,
157+
comments,
158+
expiresAt,
159+
expiredUrl,
160+
publicStats,
161+
} = this;
162+
163+
const geo = typeof this.geo === "string"
164+
? JSON.parse(this.geo)
165+
: this.geo;
166+
167+
const payload = {
168+
url,
169+
};
170+
key && (payload.key = key);
171+
domain && (payload.domain = domain);
172+
externalId && (payload.externalId = externalId);
173+
password && (payload.password = password);
174+
flexible != null && (payload.flexible = flexible);
175+
title && (payload.title = title);
176+
description && (payload.description = description);
177+
image && (payload.image = image);
178+
video && (payload.video = video);
179+
proxy != null && (payload.proxy = proxy);
180+
rewrite != null && (payload.rewrite = rewrite);
181+
ios && (payload.ios = ios);
182+
android && (payload.android = android);
183+
doIndex != null && (payload.doIndex = doIndex);
184+
comments && (payload.comments = comments);
185+
expiresAt && (payload.expiresAt = expiresAt);
186+
expiredUrl && (payload.expiredUrl = expiredUrl);
187+
geo && (payload.geo = geo);
188+
publicStats != null && (payload.publicStats = publicStats);
189+
190+
const response = await this.codeqr.createLink({
191+
$,
192+
data: payload,
193+
});
194+
response && $.export("$summary", "Link created successfully");
195+
return response;
196+
},
197+
};

‎components/codeqr/actions/create-qrcode/create-qrcode.mjs‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
import codeqr from "../../codeqr.app.mjs";
2+
3+
export default {
4+
key: "codeqr-create-qrcode",
5+
name: "Create a QR Code",
6+
description:
7+
"Creates a new QR Code in CodeQR using the QR Codes API. [See the documentation](https://codeqr.mintlify.app/api-reference/endpoint/create-a-qrcode)",
8+
version: "0.0.1",
9+
type: "action",
10+
props: {
11+
codeqr,
12+
type: {
13+
type: "string",
14+
label: "QR Code Type",
15+
description: "Select the type of QR Code to generate.",
16+
options: [
17+
"url",
18+
"text",
19+
],
20+
optional: false,
21+
},
22+
static: {
23+
type: "boolean",
24+
label: "Static/Dynamic",
25+
description:
26+
"Yes = Static QR Code (fixed content); No = Dynamic QR Code (editable content).",
27+
optional: false,
28+
default: true,
29+
},
30+
url: {
31+
type: "string",
32+
label: "URL",
33+
description: "The destination URL of the QR Code.",
34+
optional: true,
35+
},
36+
text: {
37+
type: "string",
38+
label: "Text",
39+
description: "Text content stored in the QR Code.",
40+
optional: true,
41+
},
42+
trackConversion: {
43+
type: "boolean",
44+
label: "Track Conversion",
45+
description:
46+
"Enable tracking of conversions for the QR Code. Only available for dynamic QR Codes.",
47+
optional: true,
48+
},
49+
title: {
50+
type: "string",
51+
label: "Title",
52+
description: "Title associated with the QR Code.",
53+
optional: true,
54+
},
55+
bgColor: {
56+
type: "string",
57+
label: "Background Color",
58+
description: "Background color of the QR Code.",
59+
optional: true,
60+
},
61+
fgColor: {
62+
type: "string",
63+
label: "Foreground Color",
64+
description: "Foreground color of the QR Code.",
65+
optional: true,
66+
},
67+
showLogo: {
68+
type: "boolean",
69+
label: "Show Logo",
70+
description: "Whether to display a logo in the QR Code.",
71+
optional: true,
72+
},
73+
src: {
74+
type: "string",
75+
label: "Logo URL",
76+
description:
77+
"URL of the logo to display in the QR Code (only if Show Logo is true).",
78+
optional: true,
79+
},
80+
comments: {
81+
type: "string",
82+
label: "Comments",
83+
description: "Comments or notes about the QR Code.",
84+
optional: true,
85+
},
86+
expiresAt: {
87+
type: "string",
88+
label: "Expiration Date",
89+
description:
90+
"The date and time when the short link will expire (ISO 8601). Only available for dynamic QR Codes. E.g. `2025-06-13T05:31:56Z`",
91+
optional: true,
92+
},
93+
expiredUrl: {
94+
type: "string",
95+
label: "Expired Redirect URL",
96+
description:
97+
"The URL to redirect to when the short link has expired. Only available for dynamic QR Codes.",
98+
optional: true,
99+
},
100+
},
101+
async run({ $ }) {
102+
const payload = {};
103+
for (const key of [
104+
"type",
105+
"static",
106+
"url",
107+
"text",
108+
"trackConversion",
109+
"title",
110+
"bgColor",
111+
"fgColor",
112+
"showLogo",
113+
"src",
114+
"comments",
115+
"expiresAt",
116+
"expiredUrl",
117+
]) {
118+
if (this[key] != null) payload[key] = this[key];
119+
}
120+
121+
const response = await this.codeqr.createQrcode({
122+
$,
123+
data: payload,
124+
});
125+
$.export("$summary", "QR Code created successfully.");
126+
return response;
127+
},
128+
};

‎components/codeqr/actions/delete-link/delete-link.mjs‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
import { ConfigurationError } from "@pipedream/platform";
2+
import codeqr from "../../codeqr.app.mjs";
3+
4+
export default {
5+
key: "codeqr-delete-link",
6+
name: "Delete a Link",
7+
description: "Deletes a short link in CodeQR by linkId or externalId. [See the documentation](https://codeqr.mintlify.app/api-reference/endpoint/delete-a-link)",
8+
version: "0.0.1",
9+
type: "action",
10+
props: {
11+
codeqr,
12+
linkId: {
13+
propDefinition: [
14+
codeqr,
15+
"linkId",
16+
],
17+
description: "The unique ID of the link to delete.",
18+
optional: true,
19+
},
20+
externalId: {
21+
type: "string",
22+
label: "External ID",
23+
description:
24+
"This is the ID of the link in your database. Must be prefixed with ext_.",
25+
optional: true,
26+
},
27+
},
28+
async run({ $ }) {
29+
const {
30+
linkId, externalId,
31+
} = this;
32+
if (!linkId && !externalId) {
33+
throw new ConfigurationError(
34+
"Please provide either linkId or externalId to delete the link.",
35+
);
36+
}
37+
38+
// Determine identifier to use
39+
const identifier = linkId || externalId;
40+
41+
// Perform DELETE request to /links/{identifier}
42+
await this.codeqr.deleteLink({
43+
$,
44+
identifier,
45+
});
46+
$.export("$summary", `Link deleted successfully (${identifier}).`);
47+
return {
48+
success: true,
49+
};
50+
},
51+
};

0 commit comments

Comments
 (0)