Create Custom Entity with Microsoft Dynamics 365 Sales API on New Batch Completed from OpenAI (ChatGPT) API

Pipedream makes it easy to connect APIs for Microsoft Dynamics 365 Sales, OpenAI (ChatGPT) and 2,500+ other apps remarkably fast.

Trigger workflow on

New Batch Completed from the OpenAI (ChatGPT) API

Next, do this

Create Custom Entity with the Microsoft Dynamics 365 Sales 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 OpenAI (ChatGPT) trigger and Microsoft Dynamics 365 Sales action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Batch Completed trigger
1. Connect your OpenAI (ChatGPT) account
2. Configure timer
Configure the Create Custom Entity action
1. Connect your Microsoft Dynamics 365 Sales account
2. Select a Solution ID
3. Configure Display Name
4. Configure Primary Attribute
5. Optional- Select a Language Code
6. Optional- Configure Additional Attributes
7. Optional- Configure Description
8. Optional- Configure Has Activities
9. Optional- Configure Has Notes
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 Batch Completed on OpenAI (ChatGPT)

Description:Emit new event when a new batch is completed in OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/batch/list)

Version:0.0.7

Key:openai-new-batch-completed

View on GitHub

OpenAI (ChatGPT) Overview#

OpenAI provides a suite of powerful AI models through its API, enabling developers to integrate advanced natural language processing and generative capabilities into their applications. Here’s an overview of the services offered by OpenAI's API:

Use Python or Node.js code to make fully authenticated API requests with your OpenAI account:

Trigger Code#

import common from "../common/common.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "openai-new-batch-completed",
  name: "New Batch Completed",
  description: "Emit new event when a new batch is completed in OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/batch/list)",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    _getLastCompleted() {
      return this.db.get("lastCompleted") || 0;
    },
    _setLastCompleted(lastCompleted) {
      this.db.set("lastCompleted", lastCompleted);
    },
    getMeta(batch) {
      return {
        id: batch.id,
        summary: `Batch Completed with ID ${batch.id}`,
        ts: batch.completed_at * 1000,
      };
    },
    async getAndProcessItems(max) {
      const lastCompleted = this._getLastCompleted();
      let maxCompleted = lastCompleted;
      const results = this.openai.paginate({
        resourceFn: this.openai.listBatches,
        max,
      });
      const batches = [];
      for await (const batch of results) {
        if (batch.completed_at && batch.completed_at > lastCompleted) {
          batches.push(batch);
          maxCompleted = Math.max(batch.completed_at, maxCompleted);
        }
      }
      this._setLastCompleted(maxCompleted);
      batches.reverse().forEach((item) => this.$emit(item, this.getMeta(item)));
    },
  },
  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
OpenAI (ChatGPT)	`openai`	`app`	This component uses the OpenAI (ChatGPT) app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About OpenAI (ChatGPT)#

OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.

Action#

Create Custom Entity on Microsoft Dynamics 365 Sales

Description:Create a custom entity. [See the documentation](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/create-update-entity-definitions-using-web-api)

Version:0.0.1

Key:microsoft_dynamics_365_sales-create-custom-entity

View on GitHub

Action Code#

import microsoft from "../../microsoft_dynamics_365_sales.app.mjs";
import languageCodes from "../../common/language-codes.mjs";
import pluralize from "pluralize";

export default {
  key: "microsoft_dynamics_365_sales-create-custom-entity",
  name: "Create Custom Entity",
  description: "Create a custom entity. [See the documentation](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/create-update-entity-definitions-using-web-api)",
  version: "0.0.1",
  type: "action",
  props: {
    microsoft,
    solutionId: {
      propDefinition: [
        microsoft,
        "solutionId",
      ],
    },
    displayName: {
      type: "string",
      label: "Display Name",
      description: "The name of the new entity. E.g. `Bank Account`",
    },
    primaryAttribute: {
      type: "string",
      label: "Primary Attribute",
      description: "The primary name attribute of the new entity. E.g. `Account Name`",
    },
    languageCode: {
      type: "integer",
      label: "Language Code",
      description: "The language code to use for the entity",
      options: languageCodes,
      default: 1033,
      optional: true,
    },
    additionalAttributes: {
      type: "object",
      label: "Additional Attributes",
      description: "An array of objects representing attributes to add to the custom entity. [See the documentation](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/create-update-entity-definitions-using-web-api) for more information about formatting attribute objects",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "A description of the new entity",
      optional: true,
    },
    hasActivities: {
      type: "boolean",
      label: "Has Activities",
      description: "Set to `true` if the new entity has activities",
      default: false,
      optional: true,
    },
    hasNotes: {
      type: "boolean",
      label: "Has Notes",
      description: "Set to `true` if the new entity has notes",
      default: false,
      optional: true,
    },
  },
  methods: {
    parseAttributes() {
      return this.additionalAttributes
        ? typeof this.additionalAttributes === "string"
          ? JSON.parse(this.additionalAttributes)
          : this.additionalAttributes
        : [];
    },
    removeSpaces(str) {
      return str.replace(/\s+/g, "");
    },
    buildLocalizedLabelArray(label) {
      return [
        {
          "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",
          "Label": label,
          "LanguageCode": this.languageCode,
        },
      ];
    },
  },
  async run({ $ }) {
    const solution = await this.microsoft.getSolution({
      $,
      solutionId: this.solutionId,
    });

    const { customizationprefix } = await this.microsoft.getPublisher({
      $,
      publisherId: solution._publisherid_value,
    });

    const attributes = this.parseAttributes();

    const { headers } = await this.microsoft.createCustomEntity({
      $,
      returnFullResponse: true,
      headers: {
        "MSCRM.SolutionUniqueName": solution.uniquename,
      },
      data: {
        "@odata.type": "Microsoft.Dynamics.CRM.EntityMetadata",
        "Attributes": [
          {
            "@odata.type": "Microsoft.Dynamics.CRM.StringAttributeMetadata",
            "DisplayName": {
              "@odata.type": "Microsoft.Dynamics.CRM.Label",
              "LocalizedLabels": this.buildLocalizedLabelArray(this.primaryAttribute),
            },
            "IsPrimaryName": true,
            "SchemaName": `${customizationprefix}_${this.removeSpaces(this.primaryAttribute)}`,
            "MaxLength": 100,
            "FormatName": {
              "Value": "Text",
            },
            "RequiredLevel": {
              "Value": "None",
              "CanBeChanged": true,
              "ManagedPropertyLogicalName": "canmodifyrequirementlevelsettings",
            },
          },
          ...attributes,
        ],
        "DisplayName": {
          "@odata.type": "Microsoft.Dynamics.CRM.Label",
          "LocalizedLabels": this.buildLocalizedLabelArray(this.displayName),
        },
        "DisplayCollectionName": {
          "@odata.type": "Microsoft.Dynamics.CRM.Label",
          "LocalizedLabels": this.buildLocalizedLabelArray(pluralize(this.displayName)),
        },
        "Description": this.description && {
          "@odata.type": "Microsoft.Dynamics.CRM.Label",
          "LocalizedLabels": this.buildLocalizedLabelArray(this.description),
        },
        "HasActivities": this.hasActivities,
        "HasNotes": this.hasNotes,
        "SchemaName": `${customizationprefix}_${this.removeSpaces(this.displayName)}`,
        "PrimaryNameAttribute": `${customizationprefix}_${this.removeSpaces(this.primaryAttribute)}`,
        "OwnershipType": "UserOwned",
      },
    });

    const entityId = headers["odata-entityid"].substring(headers["odata-entityid"].lastIndexOf("/") + 1);
    const response = await this.microsoft.getEntity({
      $,
      entityId,
    });

    $.export("$summary", `Successfully created custom entity with ID: ${entityId}`);

    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
Microsoft Dynamics 365 Sales	`microsoft`	`app`	This component uses the Microsoft Dynamics 365 Sales app.
Solution ID	`solutionId`	`string`	Select a value from the drop down menu.
Display Name	`displayName`	`string`	The name of the new entity. E.g. `Bank Account`
Primary Attribute	`primaryAttribute`	`string`	The primary name attribute of the new entity. E.g. `Account Name`
Language Code	`languageCode`	`integer`	Select a value from the drop down menu:`{ "label": "Afrikaans - South Africa", "value": 1078 }{ "label": "Albanian - Albania", "value": 1052 }{ "label": "Arabic - Algeria", "value": 5121 }{ "label": "Arabic - Bahrain", "value": 15361 }{ "label": "Arabic - Egypt", "value": 3073 }{ "label": "Arabic - Iraq", "value": 2049 }{ "label": "Arabic - Jordan", "value": 11265 }{ "label": "Arabic - Kuwait", "value": 13313 }{ "label": "Arabic - Lebanon", "value": 12289 }{ "label": "Arabic - Libya", "value": 4097 }{ "label": "Arabic - Morocco", "value": 6145 }{ "label": "Arabic - Oman", "value": 8193 }{ "label": "Arabic - Qatar", "value": 16385 }{ "label": "Arabic - Saudi Arabia", "value": 1025 }{ "label": "Arabic - Syria", "value": 10241 }{ "label": "Arabic - Tunisia", "value": 7169 }{ "label": "Arabic - U.A.E.", "value": 14337 }{ "label": "Arabic - Yemen", "value": 9217 }{ "label": "Armenian - Armenia", "value": 1067 }{ "label": "Azeri (Cyrillic) - Azerbaijan", "value": 2092 }{ "label": "Azeri (Latin) - Azerbaijan", "value": 1068 }{ "label": "Basque - Spain", "value": 1069 }{ "label": "Belarusian - Belarus", "value": 1059 }{ "label": "Bulgarian - Bulgaria", "value": 1026 }{ "label": "Catalan - Spain", "value": 1027 }{ "label": "Chinese - Hong Kong S.A.R.", "value": 3076 }{ "label": "Chinese - Macau S.A.R.", "value": 5124 }{ "label": "Chinese - People's Republic of China", "value": 2052 }{ "label": "Chinese - Singapore", "value": 4100 }{ "label": "Chinese - Taiwan", "value": 1028 }{ "label": "Croatian - Croatia", "value": 1050 }{ "label": "Czech - Czech Republic", "value": 1029 }{ "label": "Danish - Denmark", "value": 1030 }{ "label": "Divehi - Maldives", "value": 1125 }{ "label": "Dutch - Belgium", "value": 2067 }{ "label": "Dutch - Netherlands", "value": 1043 }{ "label": "English - Australia", "value": 3081 }{ "label": "English - Belize", "value": 10249 }{ "label": "English - Canada", "value": 4105 }{ "label": "English - Caribbean", "value": 9225 }{ "label": "English - Ireland", "value": 6153 }{ "label": "English - Jamaica", "value": 8201 }{ "label": "English - New Zealand", "value": 5129 }{ "label": "English - Republic of the Philippines", "value": 13321 }{ "label": "English - South Africa", "value": 7177 }{ "label": "English - Trinidad and Tobago", "value": 11273 }{ "label": "English - United Kingdom", "value": 2057 }{ "label": "English - United States", "value": 1033 }{ "label": "English - Zimbabwe", "value": 12297 }{ "label": "Estonian - Estonia", "value": 1061 }{ "label": "Faroese - Faeroe Islands", "value": 1080 }{ "label": "Farsi - Iran", "value": 1065 }{ "label": "Finnish - Finland", "value": 1035 }{ "label": "French - Belgium", "value": 2060 }{ "label": "French - Canada", "value": 3084 }{ "label": "French - France", "value": 1036 }{ "label": "French - Luxembourg", "value": 5132 }{ "label": "French - Monaco", "value": 6156 }{ "label": "French - Switzerland", "value": 4108 }{ "label": "Macedonian - North Macedonia", "value": 1071 }{ "label": "Galician - Spain", "value": 1110 }{ "label": "Georgian - Georgia", "value": 1079 }{ "label": "German - Austria", "value": 3079 }{ "label": "German - Germany", "value": 1031 }{ "label": "German - Liechtenstein", "value": 5127 }{ "label": "German - Luxembourg", "value": 4103 }{ "label": "German - Switzerland", "value": 2055 }{ "label": "Greek - Greece", "value": 1032 }{ "label": "Gujarati - India", "value": 1095 }{ "label": "Hebrew - Israel", "value": 1037 }{ "label": "Hindi - India", "value": 1081 }{ "label": "Hungarian - Hungary", "value": 1038 }{ "label": "Icelandic - Iceland", "value": 1039 }{ "label": "Indonesian - Indonesia", "value": 1057 }{ "label": "Italian - Italy", "value": 1040 }{ "label": "Italian - Switzerland", "value": 2064 }{ "label": "Japanese - Japan", "value": 1041 }{ "label": "Kannada - India", "value": 1099 }{ "label": "Kazakh - Kazakhstan", "value": 1087 }{ "label": "Korean - Korea", "value": 1042 }{ "label": "Latvian - Latvia", "value": 1062 }{ "label": "Lithuanian - Lithuania", "value": 1063 }{ "label": "Malay - Brunei Darussalam", "value": 2110 }{ "label": "Malay - Malaysia", "value": 1086 }{ "label": "Marathi - India", "value": 1102 }{ "label": "Mongolian - Mongolia", "value": 1104 }{ "label": "Norwegian (Bokmål) - Norway", "value": 1044 }{ "label": "Norwegian (Nynorsk) - Norway", "value": 2068 }{ "label": "Polish - Poland", "value": 1045 }{ "label": "Portuguese - Brazil", "value": 1046 }{ "label": "Portuguese - Portugal", "value": 2070 }{ "label": "Punjabi - India", "value": 1094 }{ "label": "Romanian - Romania", "value": 1048 }{ "label": "Russian - Russia", "value": 1049 }{ "label": "Spanish - Spain", "value": 1034 }{ "label": "Spanish - Mexico", "value": 2058 }{ "label": "Spanish - Argentina", "value": 11274 }{ "label": "Spanish - Chile", "value": 13322 }{ "label": "Spanish - Colombia", "value": 9226 }{ "label": "Swahili - Kenya", "value": 1089 }{ "label": "Swedish - Sweden", "value": 1053 }{ "label": "Tamil - India", "value": 1097 }{ "label": "Thai - Thailand", "value": 1054 }{ "label": "Turkish - Turkey", "value": 1055 }{ "label": "Ukrainian - Ukraine", "value": 1058 }{ "label": "Urdu - Pakistan", "value": 1056 }{ "label": "Vietnamese - Vietnam", "value": 1066 }{ "label": "Welsh - United Kingdom", "value": 1106 }`
Additional Attributes	`additionalAttributes`	`object`	An array of objects representing attributes to add to the custom entity. See the documentation for more information about formatting attribute objects
Description	`description`	`string`	A description of the new entity
Has Activities	`hasActivities`	`boolean`	Set to `true` if the new entity has activities
Has Notes	`hasNotes`	`boolean`	Set to `true` if the new entity has notes

Action Authentication#

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

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

emailoffline_accessopenidprofile