Create Album with SmugMug API on New Commit from GitHub API

Pipedream makes it easy to connect APIs for SmugMug, GitHub and 2,400+ other apps remarkably fast.

Trigger workflow on

New Commit from the GitHub API

Next, do this

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

Select this integration
Configure the New Commit trigger
1. Configure eventTypeInfo
2. Connect your GitHub account
3. Select a Repository
4. Select a Branch
Configure the Create Album action
1. Connect your SmugMug account
2. Select a Folder
3. Configure Title
4. Configure Nice Name
5. Optional- Configure URL Name
6. Optional- Select a Privacy
7. Optional- Configure Printmark URI
8. Optional- Configure Watermark URI
9. Optional- Configure Theme URI
10. Optional- Configure Template URI
11. Optional- Configure Allow Downloads
12. Optional- Configure Backprinting
13. Optional- Select a Boutique Packaging
14. Optional- Configure Can Rank
15. Optional- Configure Clean
16. Optional- Configure Comments
17. Optional- Configure Description
18. Optional- Configure Download Password
19. Optional- Configure EXIF
20. Optional- Configure Family Edit
21. Optional- Configure Filenames
22. Optional- Configure Friend Edit
23. Optional- Configure Geography
24. Optional- Select a Header
25. Optional- Configure Hide Owner
26. Optional- Configure Intercept Shipping
27. Optional- Configure Keywords
28. Optional- Configure Largest Size
29. Optional- Configure Packaging Branding
30. Optional- Configure Password
31. Optional- Configure Password Hint
32. Optional- Configure Printable
33. Optional- Configure Proof Days
34. Optional- Configure Protected
35. Optional- Configure Share
36. Optional- Configure Slideshow
37. Optional- Select a Sort Direction
38. Optional- Select a Sort Method
39. Optional- Configure Square Thumbs
40. Optional- Configure Upload Key
41. Optional- Configure Watermark
42. Optional- Select a World Searchable
43. Optional- Configure Auto Rename
44. Optional- Configure SecurityType
45. Optional- Configure Highlight Album Image URI
46. Optional- Configure Album Template URI
47. Optional- Select a Smug Searchable
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 Commit on GitHub

Description:Emit new event when commits are pushed to a branch

Version:1.0.8

Key:github-new-commit

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Trigger Code#

import common from "../common/common-flex.mjs";
import {
  getSampleTimerEvent, getSampleWebhookEvent,
} from "./common-sample-events.mjs";

export default {
  ...common,
  key: "github-new-commit",
  name: "New Commit",
  description: "Emit new event when commits are pushed to a branch",
  version: "1.0.8",
  type: "source",
  dedupe: "unique",
  props: {
    eventTypeInfo: {
      type: "alert",
      alertType: "info",
      content: "**Note:** one event is emitted for each individual commit, even if they are received at the same time.",
    },
    ...common.props,
    branch: {
      propDefinition: [
        common.props.github,
        "branch",
        (c) => ({
          repoFullname: c.repoFullname,
        }),
      ],
    },
  },
  methods: {
    ...common.methods,
    _getLastTimestamp() {
      return this.db.get("lastTimestamp") ?? Date.now();
    },
    _setLastTimestamp(value) {
      this.db.set("lastTimestamp", value);
    },
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "push",
      ];
    },
    getSummary(item) {
      return `New commit: ${item.commit?.message ?? item.message}`;
    },
    async onWebhookTrigger(event) {
      const {
        body, headers,
      } = event;
      if (body?.ref?.split?.("refs/heads/").pop() === this.branch.split("/").pop()) {
        body.commits.forEach((commit) => {
          const { id } = commit;
          this.emitEvent({
            id,
            headers,
            item: commit,
          });
        });
      }
    },
    async onTimerTrigger() {
      const { repoFullname } = this;
      const timestamp = this._getLastTimestamp();
      const since = new Date(timestamp).toISOString()
        .slice(0, -5) + "Z";
      const sha = this.branch.split("/").pop();
      const items = await this.github.getCommits({
        repoFullname,
        sha,
        since,
      });

      const savedItems = this._getSavedItems();
      const shouldEmit = this.shouldEmit();

      items
        .filter(({ sha }) => !savedItems.includes(sha))
        .sort((a, b) => {
          const dateA = new Date(a.commit.author.date);
          const dateB = new Date(b.commit.author.date);
          return dateA - dateB;
        })
        .forEach((item) => {
          const id = item.sha;
          if (shouldEmit) {
            this.emitEvent({
              id,
              item,
            });
          }
          savedItems.push(id);
        });

      this._setSavedItems(savedItems);
      this._setLastTimestamp(Date.now());
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#push";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#list-commits";
    },
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Branch	`branch`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

repoadmin:orgadmin:public_keyadmin:org_hookgistprojectnotificationsuserwrite:discussionwrite:packagesread:packagesadmin:repo_hook

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

Action#

Create Album on SmugMug

Description:Creates an album. [See the docs here](https://api.smugmug.com/api/v2/doc/reference/album.html)

Version:2.0.1

Key:smugmug-create-album

View on GitHub

SmugMug Overview#

The SmugMug API provides programmatic access to a user's SmugMug account, allowing them to manage photos, albums, and account settings. With Pipedream, you can automate tasks such as uploading new images, synchronizing photo galleries with other platforms, or triggering actions based on account activity. The API's capabilities paired with Pipedream's serverless platform enable you to craft custom workflows that react to events in SmugMug or orchestrate tasks across multiple apps.

Action Code#

import smugmug from "../../smugmug.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "smugmug-create-album",
  name: "Create Album",
  description: "Creates an album. [See the docs here](https://api.smugmug.com/api/v2/doc/reference/album.html)",
  version: "2.0.1",
  type: "action",
  props: {
    smugmug,
    folder: {
      propDefinition: [
        smugmug,
        "folder",
      ],
    },
    title: {
      type: "string",
      label: "Title",
      description: "The human-readable title.",
    },
    niceName: {
      type: "string",
      label: "Nice Name",
      description: "The user-configurable component of the album's webUri. Must begin with a capital letter.",
    },
    urlName: {
      type: "string",
      label: "URL Name",
      description: "The user-configurable component of the album's webUri.",
      optional: true,
    },
    privacy: {
      type: "string",
      label: "Privacy",
      description: "Private is not supported on legacy accounts.\nIt can be Private, Unlisted, or Public.",
      optional: true,
      options: constants.PRIVACY_OPTIONS,
    },
    printmarkUri: {
      type: "string",
      label: "Printmark URI",
      description: "Uri of an image to use in print orders of your photos, usually, a team, company logo, your signature.",
      optional: true,
    },
    watermarkUri: {
      type: "string",
      label: "Watermark URI",
      description: "Uri of an image to be applied on your photos as a watermark for protection.",
      optional: true,
    },
    themeUri: {
      type: "string",
      label: "Theme URI",
      description: "Only applies to legacy accounts.",
      optional: true,
    },
    templateUri: {
      type: "string",
      label: "Template URI",
      description: "Uri of template, preset settings to be applied on the album.",
      optional: true,
    },
    allowDownloads: {
      type: "boolean",
      label: "Allow Downloads",
      description: "Allow downloads of this album?",
      optional: true,
    },
    backprinting: {
      type: "string",
      label: "Backprinting",
      description: "Text to appear in the back of print orders of your photos.",
      optional: true,
    },
    boutiquePackaging: {
      type: "string",
      label: "Boutique Packaging",
      description: "Is this album available for Boutique Packaging in your customers orders?",
      optional: true,
      options: constants.BOUTIQUE_PACKAGING_OPTIONS,
    },
    canRank: {
      type: "boolean",
      label: "Can Rank",
      description: "Enable Canrank property of the album.",
      optional: true,
    },
    clean: {
      type: "boolean",
      label: "Clean",
      description: "Enable Clean property of the album.",
      optional: true,
    },
    comments: {
      type: "boolean",
      label: "Comments",
      description: "Allow other users leave comments in the album?",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "The human-readable description",
      optional: true,
    },
    downloadPassword: {
      type: "string",
      label: "Download Password",
      description: "The password used for protecting album download.",
      optional: true,
    },
    EXIF: {
      type: "string",
      label: "EXIF",
      description: "Display a photo's EXIF information.",
      optional: true,
    },
    familyEdit: {
      type: "boolean",
      label: "Family Edit",
      description: "Enable FamilyEdit property of the album.",
      optional: true,
    },
    filenames: {
      type: "boolean",
      label: "Filenames",
      description: "Enable Filenames property of the album.",
      optional: true,
    },
    friendEdit: {
      type: "string",
      label: "Friend Edit",
      description: "Allow this album available for granting special privileges to friends and family with an Smugmug account?",
      optional: true,
    },
    geography: {
      type: "boolean",
      label: "Geography",
      description: "Enable Geography property of the album.",
      optional: true,
    },
    header: {
      type: "string",
      label: "Header",
      description: "Use a customer header for the album appearance?",
      optional: true,
      options: constants.HEADER_OPTIONS,
    },
    hideOwner: {
      type: "boolean",
      label: "Hide Owner",
      description: "Hide owner information from the album?",
      optional: true,
    },
    interceptShipping: {
      type: "string",
      label: "Intercept Shipping",
      description: "Personal Delivery.",
      optional: true,
    },
    keywords: {
      type: "string",
      label: "Keywords",
      description: "A semicolon-separated list of keywords.",
      optional: true,
    },
    largestSize: {
      type: "string",
      label: "Largest Size",
      description: "Largest display sizes for images in the album.",
      optional: true,
    },
    packagingBranding: {
      type: "boolean",
      label: "Packaging Branding",
      description: "Enable PackagingBranding property of the album.",
      optional: true,
    },
    password: {
      type: "string",
      label: "Password",
      description: "The password used for protecting album access.",
      optional: true,
    },
    passwordHint: {
      type: "string",
      label: "Password Hint",
      description: "The hint for the album-access password.",
      optional: true,
    },
    printable: {
      type: "string",
      label: "Printable",
      description: "Allow images of this album to be available for printing?",
      optional: true,
    },
    proofDays: {
      type: "string",
      label: "Proof Days",
      description: "A proof-delay between 1 and 7 business days for customer orders.",
      optional: true,
    },
    protected: {
      type: "boolean",
      label: "Protected",
      description: "Enable right-click protection?",
      optional: true,
    },
    share: {
      type: "boolean",
      label: "Share",
      description: "Allow this album to be shared?",
      optional: true,
    },
    slideshow: {
      type: "boolean",
      label: "Slideshow",
      description: "Enable the slideshow content block on this album?",
      optional: true,
    },
    sortDirection: {
      type: "string",
      label: "Sort Direction",
      description: "Specifies the direction in which to sort album images.",
      optional: true,
      options: constants.SORT_DIRECTION_OPTIONS,
    },
    sortMethod: {
      type: "string",
      label: "Sort Method",
      description: "Album's image property to use for sorting?",
      optional: true,
      options: constants.SORT_METHOD_OPTIONS,
    },
    squareThumbs: {
      type: "boolean",
      label: "Square Thumbs",
      description: "Enable thumbnails in album's images (only available in SmugMug style).",
      optional: true,
    },
    uploadKey: {
      type: "string",
      label: "Upload Key",
      description: "A key for your guests to upload images to the album.",
      optional: true,
    },
    watermark: {
      type: "boolean",
      label: "Watermark",
      description: "Automatically apply watermark to uploaded images?",
      optional: true,
    },
    worldSearchable: {
      type: "string",
      label: "World Searchable",
      description: "Allow this album to appear in external search results? Can be \"No\" or \"Inherit from User\".",
      optional: true,
      options: constants.SEARCHABLE_OPTIONS,
    },
    autoRename: {
      type: "boolean",
      label: "Auto Rename",
      description: "Auto-rename conflicting album NiceNames?",
      optional: true,
    },
    securityType: {
      type: "string",
      label: "SecurityType",
      description: "Access protection method for the folder.",
      optional: true,
    },
    highlightAlbumImageUri: {
      type: "string",
      label: "Highlight Album Image URI",
      description: "Uri of an image which can be used as a representative of the entire album.",
      optional: true,
    },
    albumTemplateUri: {
      type: "string",
      label: "Album Template URI",
      description: "Specify default album presets by providing an AlbumTemplateUri.",
      optional: true,
    },
    smugSearchable: {
      type: "string",
      label: "Smug Searchable",
      description: "Allow this album to appear in SmugMug search results? Can be \"No\" or \"Inherit from User\".",
      optional: true,
      options: constants.SEARCHABLE_OPTIONS,
    },
  },
  async run({ $ }) {
    const data = {
      NiceName: this.niceName,
      UrlName: this.urlName,
      Title: this.title,
      Privacy: this.privacy,
      PrintmarkUri: this.printmarkUri,
      WatermarkUri: this.watermarkUri,
      ThemeUri: this.themeUri,
      TemplateUri: this.templateUri,
      AllowDownloads: this.allowDownloads,
      Backprinting: this.backprinting,
      BoutiquePackaging: this.boutiquePackaging,
      CanRank: this.canRank,
      Clean: this.clean,
      Comments: this.comments,
      Description: this.description,
      DownloadPassword: this.downloadPassword,
      EXIF: this.EXIF,
      FamilyEdit: this.familyEdit,
      Filenames: this.filenames,
      FriendEdit: this.friendEdit,
      Geography: this.geography,
      Header: this.header,
      HideOwner: this.hideOwner,
      InterceptShipping: this.interceptShipping,
      Keywords: this.keywords,
      LargestSize: this.largestSize,
      PackagingBranding: this.packagingBranding,
      Password: this.password,
      PasswordHint: this.passwordHint,
      Printable: this.printable,
      ProofDays: this.proofDays,
      Protected: this.protected,
      Share: this.share,
      Slideshow: this.slideshow,
      SortDirection: this.sortDirection,
      SortMethod: this.sortMethod,
      SquareThumbs: this.squareThumbs,
      UploadKey: this.uploadKey,
      Watermark: this.watermark,
      WorldSearchable: this.worldSearchable,
      AutoRename: this.AatoRename,
      SecurityType: this.securityType,
      HighlightAlbumImageUri: this.highlightAlbumImageUri,
      AlbumTemplateUri: this.albumTemplateUri,
      SmugSearchable: this.smugSearchable,
    };

    const nickname = await this.smugmug.getAuthenticatedUserNickname();
    const response = await this.smugmug.createAlbum(nickname, this.folder, {
      $,
      data,
    });
    if (response) {
      $.export("$summary", `Created album with key ${response.Response.Album.AlbumKey}`);
    }
    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
SmugMug	`smugmug`	`app`	This component uses the SmugMug app.
Folder	`folder`	`string`	Select a value from the drop down menu.
Title	`title`	`string`	The human-readable title.
Nice Name	`niceName`	`string`	The user-configurable component of the album's webUri. Must begin with a capital letter.
URL Name	`urlName`	`string`	The user-configurable component of the album's webUri.
Privacy	`privacy`	`string`	Select a value from the drop down menu:`PublicUnlistedPrivate`
Printmark URI	`printmarkUri`	`string`	Uri of an image to use in print orders of your photos, usually, a team, company logo, your signature.
Watermark URI	`watermarkUri`	`string`	Uri of an image to be applied on your photos as a watermark for protection.
Theme URI	`themeUri`	`string`	Only applies to legacy accounts.
Template URI	`templateUri`	`string`	Uri of template, preset settings to be applied on the album.
Allow Downloads	`allowDownloads`	`boolean`	Allow downloads of this album?
Backprinting	`backprinting`	`string`	Text to appear in the back of print orders of your photos.
Boutique Packaging	`boutiquePackaging`	`string`	Select a value from the drop down menu:`NoYesInherit from User`
Can Rank	`canRank`	`boolean`	Enable Canrank property of the album.
Clean	`clean`	`boolean`	Enable Clean property of the album.
Comments	`comments`	`boolean`	Allow other users leave comments in the album?
Description	`description`	`string`	The human-readable description
Download Password	`downloadPassword`	`string`	The password used for protecting album download.
EXIF	`EXIF`	`string`	Display a photo's EXIF information.
Family Edit	`familyEdit`	`boolean`	Enable FamilyEdit property of the album.
Filenames	`filenames`	`boolean`	Enable Filenames property of the album.
Friend Edit	`friendEdit`	`string`	Allow this album available for granting special privileges to friends and family with an Smugmug account?
Geography	`geography`	`boolean`	Enable Geography property of the album.
Header	`header`	`string`	Select a value from the drop down menu:`CustomSmugMug`
Hide Owner	`hideOwner`	`boolean`	Hide owner information from the album?
Intercept Shipping	`interceptShipping`	`string`	Personal Delivery.
Keywords	`keywords`	`string`	A semicolon-separated list of keywords.
Largest Size	`largestSize`	`string`	Largest display sizes for images in the album.
Packaging Branding	`packagingBranding`	`boolean`	Enable PackagingBranding property of the album.
Password	`password`	`string`	The password used for protecting album access.
Password Hint	`passwordHint`	`string`	The hint for the album-access password.
Printable	`printable`	`string`	Allow images of this album to be available for printing?
Proof Days	`proofDays`	`string`	A proof-delay between 1 and 7 business days for customer orders.
Protected	`protected`	`boolean`	Enable right-click protection?
Share	`share`	`boolean`	Allow this album to be shared?
Slideshow	`slideshow`	`boolean`	Enable the slideshow content block on this album?
Sort Direction	`sortDirection`	`string`	Select a value from the drop down menu:`AscendingDescending`
Sort Method	`sortMethod`	`string`	Select a value from the drop down menu:`PositionCaptionFilenameDate UploadedDate ModifiedDate Taken`
Square Thumbs	`squareThumbs`	`boolean`	Enable thumbnails in album's images (only available in SmugMug style).
Upload Key	`uploadKey`	`string`	A key for your guests to upload images to the album.
Watermark	`watermark`	`boolean`	Automatically apply watermark to uploaded images?
World Searchable	`worldSearchable`	`string`	Select a value from the drop down menu:`NoInherit from User`
Auto Rename	`autoRename`	`boolean`	Auto-rename conflicting album NiceNames?
SecurityType	`securityType`	`string`	Access protection method for the folder.
Highlight Album Image URI	`highlightAlbumImageUri`	`string`	Uri of an image which can be used as a representative of the entire album.
Album Template URI	`albumTemplateUri`	`string`	Specify default album presets by providing an AlbumTemplateUri.
Smug Searchable	`smugSearchable`	`string`	Select a value from the drop down menu:`NoInherit from User`

Action Authentication#

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

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

Create Album with SmugMug API on New Commit from GitHub API

Pipedream makes it easy to connect APIs for SmugMug, GitHub and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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