Create Customer with Help Scout API on New or Updated Page in Data Source (By Property) from Notion API

Pipedream makes it easy to connect APIs for Help Scout, Notion and 2,800+ other apps remarkably fast.

Trigger workflow on

New or Updated Page in Data Source (By Property) from the Notion API

Next, do this

Create Customer with the Help Scout 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 Notion trigger and Help Scout action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New or Updated Page in Data Source (By Property) trigger
1. Connect your Notion account
2. Configure timer
3. Select a Data Source ID
4. Configure Include New Pages
5. Optional- Select one or more Property Types
6. Configure alert
Configure the Create Customer action
1. Connect your Help Scout account
2. Optional- Configure First Name
3. Optional- Configure Last Name
4. Optional- Configure Phone
5. Optional- Configure Photo URL
6. Optional- Configure Job Title
7. Optional- Select a Photo Type
8. Optional- Configure Background
9. Optional- Configure Location
10. Optional- Configure Organization
11. Optional- Select a Gender
12. Optional- Configure Age
13. Optional- Configure Emails
14. Optional- Configure Phones
15. Optional- Configure Chats
16. Optional- Configure Social Profiles
17. Optional- Configure Websites
18. Optional- Configure Address City
19. Optional- Configure Address State
20. Optional- Configure Address Postal Code
21. Optional- Configure Address Country
22. Optional- Configure Address Lines
23. Optional- Configure Properties
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 or Updated Page in Data Source (By Property) on Notion

Description:Emit new event when a page is created or updated in the selected data source. [See the documentation](https://developers.notion.com/reference/page)

Version:1.0.0

Key:notion-updated-page

View on GitHub

Notion Overview#

Notion's API allows for the creation, reading, updating, and deleting of pages, databases, and their contents within Notion. Using Pipedream's platform, you can build workflows that connect Notion with various other services to automate tasks such as content management, task tracking, and data synchronization. With Pipedream's serverless execution, you can trigger these workflows on a schedule, or by external events from other services, without managing any infrastructure.

Trigger Code#

import zlib from "zlib"; import notion from "../../notion.app.mjs"; import base from "../common/base.mjs"; import constants from "../common/constants.mjs"; import sampleEmit from "./test-event.mjs"; export default { ...base, key: "notion-updated-page", name: "New or Updated Page in Data Source (By Property)", description: "Emit new event when a page is created or updated in the selected data source. [See the documentation](https://developers.notion.com/reference/page)", version: "1.0.0", type: "source", dedupe: "unique", props: { ...base.props, dataSourceId: { propDefinition: [ notion, "dataSourceId", ], }, includeNewPages: { type: "boolean", label: "Include New Pages", description: "Set to `false` to emit events only for updates, not for new pages.", default: true, }, properties: { propDefinition: [ notion, "propertyTypes", (c) => ({ parentId: c.dataSourceId, parentType: "data_source", }), ], description: "Only emit events when one or more of the selected properties have changed", optional: true, }, alert: { type: "alert", alertType: "warning", content: "Source not saving? Your database might be too large. If deployment takes longer than one minute, an error will occur.", }, }, hooks: { async activate() { console.log("Activating: fetching pages and properties"); this._setLastUpdatedTimestamp(Date.now()); const propertyValues = {}; const propertiesToCheck = await this._getPropertiesToCheck(); const params = this.lastUpdatedSortParam(); const pagesStream = this.notion.getPages(this.dataSourceId, params); for await (const page of pagesStream) { for (const propertyName of propertiesToCheck) { const currentValue = this._maybeRemoveFileSubItems(page.properties[propertyName]); propertyValues[page.id] = { ...propertyValues[page.id], [propertyName]: currentValue, }; } } this._setPropertyValues(propertyValues); }, async deactivate() { console.log("Deactivating: clearing states"); this._setLastUpdatedTimestamp(null); }, }, methods: { ...base.methods, _getLastUpdatedTimestamp() { return this.db.get(constants.timestamps.LAST_EDITED_TIME); }, _setLastUpdatedTimestamp(ts) { this.db.set(constants.timestamps.LAST_EDITED_TIME, ts); }, _getPropertyValues() { const compressed = this.db.get("propertyValues"); const buffer = Buffer.from(compressed, "base64"); const decompressed = zlib.inflateSync(buffer).toString(); return JSON.parse(decompressed); }, _setPropertyValues(propertyValues) { const string = JSON.stringify(propertyValues); const compressed = zlib.deflateSync(string).toString("base64"); this.db.set("propertyValues", compressed); }, async _getPropertiesToCheck() { if (this.properties?.length) { return this.properties; } const { properties } = await this.notion.retrieveDataSource(this.dataSourceId); return Object.keys(properties); }, _maybeRemoveFileSubItems(property) { // Files & Media type: // `url` and `expiry_time` are constantly updated by Notion, so ignore these fields if (property.type === "files") { const modified = structuredClone(property); for (const file of modified.files) { if (file.type === "file") { delete file.file; } } return modified; } return property; }, _generateMeta(obj, summary) { const { id } = obj; const title = this.notion.extractPageTitle(obj); const ts = Date.now(); return { id: `${id}-${ts}`, summary: `${summary}: ${title}`, ts, }; }, _emitEvent(page, changes = [], isNewPage = true) { const meta = isNewPage ? this._generateMeta(page, constants.summaries.PAGE_ADDED) : this._generateMeta(page, constants.summaries.PAGE_UPDATED); const event = { page, changes, }; this.$emit(event, meta); }, }, async run() { const lastCheckedTimestamp = this._getLastUpdatedTimestamp(); const propertyValues = this._getPropertyValues(); if (!lastCheckedTimestamp) { // recently updated (deactivated / activated), skip execution console.log("Awaiting restart completion: skipping execution"); return; } const params = { ...this.lastUpdatedSortParam(), filter: { timestamp: "last_edited_time", last_edited_time: { on_or_after: new Date(lastCheckedTimestamp).toISOString(), }, }, }; let newLastUpdatedTimestamp = lastCheckedTimestamp; const propertiesToCheck = await this._getPropertiesToCheck(); const pagesStream = this.notion.getPages(this.dataSourceId, params); for await (const page of pagesStream) { const changes = []; let isNewPage = false; let propertyHasChanged = false; newLastUpdatedTimestamp = Math.max( newLastUpdatedTimestamp, Date.parse(page.last_edited_time), ); if (lastCheckedTimestamp > Date.parse(page.last_edited_time)) { break; } // Check if this is a new page first const pageExistsInDB = propertyValues[page.id] != null; isNewPage = !pageExistsInDB; for (const propertyName of propertiesToCheck) { const previousValue = structuredClone(propertyValues[page.id]?.[propertyName]); // value used to compare and to save to this.db const currentValueToSave = this._maybeRemoveFileSubItems(page.properties[propertyName]); // (unmodified) value that should be emitted const currentValueToEmit = page.properties[propertyName]; const propertyChanged = JSON.stringify(previousValue) !== JSON.stringify(currentValueToSave); if (pageExistsInDB && propertyChanged) { propertyHasChanged = true; propertyValues[page.id] = { ...propertyValues[page.id], [propertyName]: currentValueToSave, }; changes.push({ property: propertyName, previousValue, currentValue: currentValueToEmit, }); } if (!pageExistsInDB) { // For new pages, always track the properties if (!propertyValues[page.id]) { propertyValues[page.id] = {}; } propertyValues[page.id][propertyName] = currentValueToSave; // Only mark as changed (to emit event) if includeNewPages is true if (this.includeNewPages) { propertyHasChanged = true; changes.push({ property: propertyName, previousValue, currentValue: currentValueToEmit, }); } } } // Only emit events if: // 1. It's an existing page with changes, OR // 2. It's a new page and includeNewPages is true if (propertyHasChanged && (!isNewPage || this.includeNewPages)) { this._emitEvent(page, changes, isNewPage); } } this._setLastUpdatedTimestamp(newLastUpdatedTimestamp); this._setPropertyValues(propertyValues); }, sampleEmit, };

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
Notion	`notion`	`app`	This component uses the Notion app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Data Source ID	`dataSourceId`	`string`	Select a value from the drop down menu.
Include New Pages	`includeNewPages`	`boolean`	Set to `false` to emit events only for updates, not for new pages.
Property Types	`properties`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

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

About 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.

Action#

Create Customer on Help Scout

Description:Creates a new customer record in Help Scout. [See the documentation](https://developer.helpscout.com/mailbox-api/endpoints/customers/create/)

Version:0.0.3

Key:help_scout-create-customer

View on GitHub

Help Scout Overview#

The Help Scout API provides programmatic access to customer support functionalities, allowing the automation of ticketing, customer communication, and reporting tasks. With this API, you can read and send messages, manage conversations, work with mailboxes, create and update customers’ information, and generate reports. Utilizing the API on Pipedream, you can automate workflows that respond to events in Help Scout in real-time, integrate customer support data with other business tools, and streamline support operations.

Action Code#

import { ConfigurationError } from "@pipedream/platform"; import { GENDER_OPTIONS, PHOTO_TYPE_OPTIONS, } from "../../common/constants.mjs"; import { cleanObject, parseObject, } from "../../common/utils.mjs"; import helpScout from "../../help_scout.app.mjs"; export default { key: "help_scout-create-customer", name: "Create Customer", description: "Creates a new customer record in Help Scout. [See the documentation](https://developer.helpscout.com/mailbox-api/endpoints/customers/create/)", version: "0.0.3", annotations: { destructiveHint: false, openWorldHint: true, readOnlyHint: false, }, type: "action", props: { helpScout, firstName: { type: "string", label: "First Name", description: "First name of the customer. When defined it must be between 1 and 40 characters.", optional: true, }, lastName: { type: "string", label: "Last Name", description: "Last name of the customer. When defined it must be between 1 and 40 characters.", optional: true, }, phone: { type: "string", label: "Phone", description: "The phone number that will be used when creating a new customer.", optional: true, }, photoUrl: { type: "string", label: "Photo URL", description: "URL of the customer's photo. Max length 200 characters.", optional: true, }, jobTitle: { type: "string", label: "Job Title", description: "Job title. Max length 60 characters.", optional: true, }, photoType: { type: "string", label: "Photo Type", description: "The type of photo.", options: PHOTO_TYPE_OPTIONS, optional: true, }, background: { type: "string", label: "Background", description: "This is the Notes field from the user interface. Max length 200 characters.", optional: true, }, location: { type: "string", label: "Location", description: "Location of the customer. Max length 60 characters.", optional: true, }, organization: { type: "string", label: "Organization", description: "Organization. Max length 60 characters.", optional: true, }, gender: { type: "string", label: "Gender", description: "Gender of this customer.", options: GENDER_OPTIONS, optional: true, }, age: { type: "string", label: "Age", description: "Customer's age.", optional: true, }, emails: { type: "string[]", label: "Emails", description: "List of email entries. **Format: {\"type\":\"home\",\"value\":\"customer@email.com\"}**. see [Create Email](https://developer.helpscout.com/mailbox-api/endpoints/customers/emails/create) for the object documentation.", optional: true, }, phones: { type: "string[]", label: "Phones", description: "List of phone entries. **Format: {\"type\":\"work\",\"value\":\"222-333-4444\"}**. see [Create Phone](https://developer.helpscout.com/mailbox-api/endpoints/customers/phones/create) for the object documentation.", optional: true, }, chats: { type: "string[]", label: "Chats", description: "List of chat entries. **Format: {\"type\":\"aim\",\"value\":\"jsprout\"}**. see [Create Chat Handle](https://developer.helpscout.com/mailbox-api/endpoints/customers/chat_handles/create) for the object documentation.", optional: true, }, socialProfiles: { type: "string[]", label: "Social Profiles", description: "List of social profile entries. **Format: {\"type\":\"googleplus\",\"value\":\"https://api.helpscout.net/+HelpscoutNet\"}**. see [Create Social Profile](https://developer.helpscout.com/mailbox-api/endpoints/customers/social_profiles/create) for the object documentation.", optional: true, }, websites: { type: "string[]", label: "Websites", description: "List of websites entries. **Format: {\"value\":\"https://api.helpscout.net/\"}**. see [Create Website](https://developer.helpscout.com/mailbox-api/endpoints/customers/websites/create) for the object documentation.", optional: true, }, addressCity: { type: "string", label: "Address City", description: "The city of the customer.", optional: true, }, addressState: { type: "string", label: "Address State", description: "The state of the customer.", optional: true, }, addressPostalCode: { type: "string", label: "Address Postal Code", description: "The postal code of the customer.", optional: true, }, addressCountry: { type: "string", label: "Address Country", description: "The [ISO 3166 Alpha-2 code](https://www.iban.com/country-codes) country of the customer.", optional: true, }, addressLines: { type: "string[]", label: "Address Lines", description: "A list of address lines.", optional: true, }, properties: { type: "string[]", label: "Properties", description: "List of social profile entries. **Format: {\"type\":\"googleplus\",\"value\":\"https://api.helpscout.net/+HelpscoutNet\"}**. see [Create Social Profile](https://developer.helpscout.com/mailbox-api/endpoints/customers/social_profiles/create) for the object documentation.", optional: true, }, }, async run({ $ }) { const address = cleanObject({ city: this.addressCity, state: this.addressState, postalCode: this.addressPostalCode, country: this.addressCountry, lines: parseObject(this.addressLines), properties: parseObject(this.properties), }); let data = {}; data = cleanObject({ firstName: this.firstName, lastName: this.lastName, phone: this.phone, photoUrl: this.photoUrl, jobTitle: this.jobTitle, photoType: this.photoType, background: this.background, location: this.location, organization: this.organization, gender: this.gender, age: this.age, emails: parseObject(this.emails), phones: parseObject(this.phones), chats: parseObject(this.chats), socialProfiles: parseObject(this.socialProfiles), websites: parseObject(this.websites), }); if (Object.keys(address).length) data.address = address; if (!Object.keys(data).length) { throw new ConfigurationError("At least one field or customer entry must be defined."); } try { const response = await this.helpScout.createCustomer({ $, data, }); $.export("$summary", "Successfully created the new customer."); return response; } catch ({ message }) { const error = JSON.parse(message)._embedded.errors[0]; throw new ConfigurationError(`Path: ${error.path} - ${error.message}`); } }, };

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
Help Scout	`helpScout`	`app`	This component uses the Help Scout app.
First Name	`firstName`	`string`	First name of the customer. When defined it must be between 1 and 40 characters.
Last Name	`lastName`	`string`	Last name of the customer. When defined it must be between 1 and 40 characters.
Phone	`phone`	`string`	The phone number that will be used when creating a new customer.
Photo URL	`photoUrl`	`string`	URL of the customer's photo. Max length 200 characters.
Job Title	`jobTitle`	`string`	Job title. Max length 60 characters.
Photo Type	`photoType`	`string`	Select a value from the drop down menu:`unknowngravatartwitterfacebookgoogleprofilegooglepluslinkedininstagram`
Background	`background`	`string`	This is the Notes field from the user interface. Max length 200 characters.
Location	`location`	`string`	Location of the customer. Max length 60 characters.
Organization	`organization`	`string`	Organization. Max length 60 characters.
Gender	`gender`	`string`	Select a value from the drop down menu:`malefemaleunknown`
Age	`age`	`string`	Customer's age.
Emails	`emails`	`string[]`	List of email entries. Format: {"type":"home","value":"customer@email.com"}. see Create Email for the object documentation.
Phones	`phones`	`string[]`	List of phone entries. Format: {"type":"work","value":"222-333-4444"}. see Create Phone for the object documentation.
Chats	`chats`	`string[]`	List of chat entries. Format: {"type":"aim","value":"jsprout"}. see Create Chat Handle for the object documentation.
Social Profiles	`socialProfiles`	`string[]`	List of social profile entries. Format: {"type":"googleplus","value":"https://api.helpscout.net/+HelpscoutNet"}. see Create Social Profile for the object documentation.
Websites	`websites`	`string[]`	List of websites entries. Format: {"value":"https://api.helpscout.net/"}. see Create Website for the object documentation.
Address City	`addressCity`	`string`	The city of the customer.
Address State	`addressState`	`string`	The state of the customer.
Address Postal Code	`addressPostalCode`	`string`	The postal code of the customer.
Address Country	`addressCountry`	`string`	The ISO 3166 Alpha-2 code country of the customer.
Address Lines	`addressLines`	`string[]`	A list of address lines.
Properties	`properties`	`string[]`	List of social profile entries. Format: {"type":"googleplus","value":"https://api.helpscout.net/+HelpscoutNet"}. see Create Social Profile for the object documentation.

Action Authentication#

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

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

Create Customer with Help Scout API on New or Updated Page in Data Source (By Property) from Notion API

Pipedream makes it easy to connect APIs for Help Scout, Notion and 2,800+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

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