Create Order with Order Desk API on New Webhook Event (Instant) from GitHub API

Pipedream makes it easy to connect APIs for Order Desk, GitHub and 2,500+ other apps remarkably fast.

Trigger workflow on

New Webhook Event (Instant) from the GitHub API

Next, do this

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

Select this integration
Configure the New Webhook Event (Instant) trigger
1. Configure docsInfo
2. Connect your GitHub account
3. Select a Repository
4. Select one or more Webhook Events
Configure the Create Order action
1. Connect your Order Desk account
2. Configure Order Items
3. Optional- Configure Customer First Name
4. Optional- Configure Customer Last Name
5. Optional- Configure Customer Company
6. Optional- Configure Shipping First Name
7. Optional- Configure Shipping Last Name
8. Optional- Configure Shipping Company
9. Optional- Configure Source ID
10. Optional- Select a Source Name
11. Optional- Configure Email
12. Optional- Configure Shipping Method
13. Optional- Configure Quantity Total
14. Optional- Configure Weight Total
15. Optional- Configure Product Total
16. Optional- Configure Shipping Total
17. Optional- Configure Handling Total
18. Optional- Configure Tax Total
19. Optional- Configure Discount Total
20. Optional- Configure Order Total
21. Optional- Configure Credit Card Number
22. Optional- Configure Credit Card Expiration
23. Optional- Configure Processor Response
24. Optional- Configure Payment Type
25. Optional- Select a Payment Status
26. Optional- Configure Processor Balance
27. Optional- Configure Refund Total
28. Optional- Configure Customer ID
29. Optional- Configure IP Address
30. Optional- Configure Fulfillment ID
31. Optional- Configure Fulfillment Name
32. Optional- Configure Folder ID
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 Webhook Event (Instant) on GitHub

Description:Emit new event for each selected event type

Version:1.0.10

Key:github-webhook-events

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-webhook.mjs";
import constants from "../common/constants.mjs";
import { getRelevantHeaders } from "../common/utils.mjs";

export default {
  ...common,
  key: "github-webhook-events",
  name: "New Webhook Event (Instant)",
  description: "Emit new event for each selected event type",
  type: "source",
  version: "1.0.10",
  dedupe: "unique",
  props: {
    docsInfo: {
      type: "alert",
      alertType: "info",
      content: "[See the GitHub documentation](https://docs.github.com/en/webhooks/webhook-events-and-payloads) for more information on available events.",
    },
    ...common.props,
    events: {
      label: "Webhook Events",
      description: "The event types to be emitted",
      type: "string[]",
      options: constants.REPOSITORY_WEBHOOK_EVENTS,
      reloadProps: true,
    },
  },
  async additionalProps() {
    await this.requireAdminPermission();
    const props = {};
    if (this.events?.length && this.events.includes("pull_request_review")) {
      props.reviewState = {
        type: "string",
        label: "Review State",
        description: "Filter `pull_request_review` events by review state",
        options: constants.PULL_REQUEST_REVIEW_STATES,
        optional: true,
      };
    }
    return props;
  },
  methods: {
    ...common.methods,
    getWebhookEvents() {
      return this.events;
    },
  },
  async run(event) {
    const {
      headers,
      body,
    } = event;

    // skip initial response from Github
    if (body?.zen) {
      console.log(body.zen);
      return;
    }

    if (headers["x-github-event"] === "pull_request_review" && this.reviewState && body.review.state !== this.reviewState) {
      return;
    }

    this.$emit({
      ...getRelevantHeaders(headers),
      ...body,
    }, {
      id: headers["x-github-delivery"],
      summary: `New event ${headers["x-github-hook-installation-target-id"]} of type ${headers["x-github-hook-installation-target-type"]}`,
      ts: new Date(),
    });
  },
  async activate() {
    const isAdmin = await this.checkAdminPermission();
    if (!isAdmin) {
      throw new Error("Webhooks are only supported on repos where you have admin access.");
    }
    await this.createWebhook();
  },
};

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.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Webhook Events	`events`	`string[]`	Select a value from the drop down menu:`{ "label": "Activity related to a branch protection rule", "value": "branch_protection_rule" }{ "label": "Check run activity has occurred", "value": "check_run" }{ "label": "Check suite activity has occurred", "value": "check_suite" }{ "label": "Activity related to code scanning alerts in a repository", "value": "code_scanning_alert" }{ "label": "A commit comment is created", "value": "commit_comment" }{ "label": "A Git branch or tag is created", "value": "create" }{ "label": "A Git branch or tag is deleted", "value": "delete" }{ "label": "A deploy key is added or removed from a repository", "value": "deploy_key" }{ "label": "A deployment is created", "value": "deployment_status" }{ "label": "Activity related to a discussion", "value": "discussion" }{ "label": "Activity related to a comment in a discussion", "value": "discussion_comment" }{ "label": "A user forks a repository", "value": "fork" }{ "label": "A wiki page is created or updated", "value": "gollum" }{ "label": "Activity related to an issue or pull request comment", "value": "issue_comment" }{ "label": "Activity related to an issue", "value": "issues" }{ "label": "Activity related to a label", "value": "label" }{ "label": "Activity related to repository collaborators", "value": "member" }{ "label": "The webhook this event is configured on was deleted", "value": "meta" }{ "label": "Activity related to milestones", "value": "milestone" }{ "label": "Activity related to GitHub Packages", "value": "package" }{ "label": "Activity on attempted build of a GitHub Pages site, whether successful or not", "value": "page_build" }{ "label": "Activity related to project boards", "value": "project" }{ "label": "Activity related to project cards", "value": "project_card" }{ "label": "Activity related to columns in a project board", "value": "project_column" }{ "label": "When a private repository is made public", "value": "public" }{ "label": "Activity related to pull requests", "value": "pull_request" }{ "label": "Activity related to pull request reviews", "value": "pull_request_review" }{ "label": "Activity related to pull request review comments in the pull request's unified diff", "value": "pull_request_review_comment" }{ "label": "Activity related to a comment thread on a pull request being marked as resolved or unresolved", "value": "pull_request_review_thread" }{ "label": "One or more commits are pushed to a repository branch or tag", "value": "push" }{ "label": "Activity related to a release", "value": "release" }{ "label": "Activity related to a repository", "value": "repository" }{ "label": "Activity related to a repository being imported to GitHub", "value": "repository_import" }{ "label": "Activity related to security vulnerability alerts in a repository", "value": "repository_vulnerability_alert" }{ "label": "Activity related to a repository being starred", "value": "star" }{ "label": "When the status of a Git commit changes", "value": "status" }{ "label": "When a repository is added to a team", "value": "team_add" }{ "label": "When someone stars a repository", "value": "watch" }{ "label": "A GitHub Actions workflow job has been queued, is in progress, or has been completed on a repository", "value": "workflow_job" }{ "label": "When a GitHub Actions workflow run is requested or completed", "value": "workflow_run" }`

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:

reporead:orgadmin:org_hookgistprojectnotificationsread:userwrite:discussionadmin: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 Order on Order Desk

Description:Create Order [See the documentation](https://apidocs.orderdesk.com/#create-an-order).

Version:0.0.1

Key:order_desk-create-order

View on GitHub

Order Desk Overview#

The Order Desk API allows you to automate and streamline order management processes within the Order Desk platform. With this API, you have the power to create, update, and get detailed information on orders, inventory, and shipments. Pipedream's serverless platform enables you to connect the Order Desk API with numerous other apps and services to build dynamic workflows. Whether you're syncing order data, managing inventory, or connecting to fulfillment services, Pipedream can help you craft custom automations that save time and reduce manual errors.

Action Code#

import { getParsedOrderItems } from "../../common/validate-order-items.mjs";
import app  from "../../order_desk.app.mjs";

export default {
  name: "Create Order",
  description: "Create Order [See the documentation](https://apidocs.orderdesk.com/#create-an-order).",
  key: "order_desk-create-order",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    order_items: {
      propDefinition: [
        app,
        "order_items",
      ],
    },
    customer_first_name: {
      propDefinition: [
        app,
        "customer_first_name",
      ],
    },
    customer_last_name: {
      propDefinition: [
        app,
        "customer_last_name",
      ],
    },
    customer_company: {
      propDefinition: [
        app,
        "customer_company",
      ],
    },
    shipping_first_name: {
      propDefinition: [
        app,
        "shipping_first_name",
      ],
    },
    shipping_last_name: {
      propDefinition: [
        app,
        "shipping_last_name",
      ],
    },
    shipping_company: {
      propDefinition: [
        app,
        "shipping_company",
      ],
    },
    source_id: {
      propDefinition: [
        app,
        "source_id",
      ],
    },
    source_name: {
      propDefinition: [
        app,
        "source_name",
      ],
    },
    email: {
      propDefinition: [
        app,
        "email",
      ],
    },
    shipping_method: {
      propDefinition: [
        app,
        "shipping_method",
      ],
    },
    quantity_total: {
      propDefinition: [
        app,
        "quantity_total",
      ],
    },
    weight_total: {
      propDefinition: [
        app,
        "weight_total",
      ],
    },
    product_total: {
      propDefinition: [
        app,
        "product_total",
      ],
    },
    shipping_total: {
      propDefinition: [
        app,
        "shipping_total",
      ],
    },
    handling_total: {
      propDefinition: [
        app,
        "handling_total",
      ],
    },
    tax_total: {
      propDefinition: [
        app,
        "tax_total",
      ],
    },
    discount_total: {
      propDefinition: [
        app,
        "discount_total",
      ],
    },
    order_total: {
      propDefinition: [
        app,
        "order_total",
      ],
    },
    cc_number: {
      propDefinition: [
        app,
        "cc_number",
      ],
    },
    cc_exp: {
      propDefinition: [
        app,
        "cc_exp",
      ],
    },
    processor_response: {
      propDefinition: [
        app,
        "processor_response",
      ],
    },
    payment_type: {
      propDefinition: [
        app,
        "payment_type",
      ],
    },
    payment_status: {
      propDefinition: [
        app,
        "payment_status",
      ],
    },
    processor_balance: {
      propDefinition: [
        app,
        "processor_balance",
      ],
    },
    refund_total: {
      propDefinition: [
        app,
        "refund_total",
      ],
    },
    customer_id: {
      propDefinition: [
        app,
        "customer_id",
      ],
    },
    ip_address: {
      propDefinition: [
        app,
        "ip_address",
      ],
    },
    fulfillment_id: {
      propDefinition: [
        app,
        "fulfillment_id",
      ],
    },
    fulfillment_name: {
      propDefinition: [
        app,
        "fulfillment_name",
      ],
    },
    folder_id: {
      propDefinition: [
        app,
        "folder_id",
      ],
    },
  },
  async run({ $ }) {
    const {
      app,
      ...data
    } = this;

    const res = await app.createOrder({
      ...data,
      order_items: getParsedOrderItems(data.order_items),
    });
    $.export("summary", `Order successfully created with id "${res.order.id}".`);
    return res;
  },
};

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
Order Desk	`app`	`app`	This component uses the Order Desk app.
Order Items	`order_items`	`string[]`	A valid JSON string. Order Items Object can have the following properties: `id, name, price, quantity, weight, code, delivery_type, category_code, variation_list, metadata`. Please check the documentation in the description for more information.
Customer First Name	`customer_first_name`	`string`	Customer first name
Customer Last Name	`customer_last_name`	`string`	Customer last name
Customer Company	`customer_company`	`string`	Customer company
Shipping First Name	`shipping_first_name`	`string`	Shipping first name
Shipping Last Name	`shipping_last_name`	`string`	Shipping last name
Shipping Company	`shipping_company`	`string`	Shipping company
Source ID	`source_id`	`string`	Your order ID. If blank, Order Desk's internal ID will be used read-only.
Source Name	`source_name`	`string`	Select a value from the drop down menu:`Order DeskFoxyCartWooCommerceBigCommerceAmazonShopifyeBayMagentoMagento 2GumroadWufooInterspirePayPalStripeEtsyJetZapierSpark PaySnipcartRecurlyVolusionChargebeeWeeblyWalmartWalmart.comModular MerchantEcwidUltraCartnopCommerceSquarespaceCeleryE-junkieCommerceHQBrightStoresSamCartWayfairSpree`
Email	`email`	`string`	Customer email address
Shipping Method	`shipping_method`	`string`	Name of shipping method selected.
Quantity Total	`quantity_total`	`string`	Total number of items in the order.
Weight Total	`weight_total`	`string`	Total weight of the order.
Product Total	`product_total`	`string`	Total cost of all items in the order.
Shipping Total	`shipping_total`	`string`	Total cost of shipping.
Handling Total	`handling_total`	`string`	Total cost of handling.
Tax Total	`tax_total`	`string`	Total cost of tax.
Discount Total	`discount_total`	`string`	Total cost of discounts.
Order Total	`order_total`	`string`	Total cost of the order.
Credit Card Number	`cc_number`	`string`	Obfuscated credit card number. Enter only the last four digits.
Credit Card Expiration	`cc_exp`	`string`	Credit card expiration date in MM/YYYY format.
Processor Response	`processor_response`	`string`	Gateway transaction ID in format `<gateway_name>: <transaction_id>`
Payment Type	`payment_type`	`string`	Payment type. Can be `Visa`, `Paypal`, `Mastercard`, etc
Payment Status	`payment_status`	`string`	Select a value from the drop down menu:`ApprovedAuthorizedCapturedFully RefundedPartially RefundedPendingRejectedVoided`
Processor Balance	`processor_balance`	`string`	The amount that the was charged at the processor. This amount will be decremented when refunds are made. By default it will be set the same as `order_total`
Refund Total	`refund_total`	`string`	The amount that jhas been refunded on the order from within Order Desk. This is generally something that will be set internally.
Customer ID	`customer_id`	`string`	The ID of the customer. This is generally something that will be set internally.
IP Address	`ip_address`	`string`	The IP address of the customer.
Fulfillment ID	`fulfillment_id`	`string`	The internal ID of the fulfillment service will be saved here for some services.
Fulfillment Name	`fulfillment_name`	`string`	Once the order has been sent for fulfillment, the name of the fulfillment method is entered here.
Folder ID	`folder_id`	`string`	The ID number of the folder in which the order is stored. If nothing is entered when adding an order, the folder will be the first folder in the list.

Action Authentication#

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

To retrieve your API key,

Navigate to your Order Desk account and sign in
Go to “Store Settings” > “API”

Create Order with Order Desk API on New Webhook Event (Instant) from GitHub API

Pipedream makes it easy to connect APIs for Order Desk, GitHub and 2,500+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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