ワークフロー | カスタムコードアクション

​

Node.js対応ライブラリー

• @hubspot/api-client ^10
• async ^3.2.0
• aws-sdk ^2.744.0
• axios ^1.2.0
• lodash ^4.17.20
• mongoose ^6.8.0
• mysql ^2.18.1
• redis” ^4.5.1
• request” ^2.88.2
• bluebird ^3.7.2
• random-number-csprng ^1.0.2
• googleapis ^67.0.0

​

Python対応ライブラリー

• requests 2.28.2
• @hubspot/api-client ^8
• google-api-python-client 2.74.0
• mysql-connector-python 8.0.32
• redis 4.4.2
• nltk 3.8.1

​

使い始めるには

​

コード サンプル

const hubspot = require('@hubspot/api-client');

exports.main = async (event, callback) => {

  /*****
    How to use secrets
    Secrets are a way for you to save API keys or private apps and set them as a variable to use anywhere in your code
    Each secret needs to be defined like the example below
  *****/

  const hubspotClient = new hubspot.Client({
    accessToken: process.env.SECRET_NAME
  });

  let phone;
  try {
    const ApiResponse = await hubspotClient.crm.contacts.basicApi.getById(event.object.objectId, ["phone"]);
    phone = ApiResponse.properties.phone;
  } catch (err) {
    console.error(err);
    // We will automatically retry when the code fails because of a rate limiting error from the HubSpot API.
    throw err;
  }

  /*****
    How to use inputs
    Inputs are a way for you to take data from any actions in your workflow and use it in your code instead of having to call the HubSpot API to get that same data.
    Each input needs to be defined like the example below
  *****/

  const email = event.inputFields['email'];

  /*****
    How to use outputs
    Outputs are a way for you to take data from your code and use it in later workflows actions

    Use the callback function to return data that can be used in later actions.
    Data won't be returned until after the event loop is empty, so any code after this will still execute.
  *****/

  callback({
    outputFields: {
      email: email,
      phone: phone
    }
  });
}

// A sample event may look like:
{
  "origin": {
    // Your portal ID
    "portalId": 1,

    // Your custom action definition ID
    "actionDefinitionId": 2,
  },
  "object": {
    // The type of CRM object that is enrolled in the workflow
    "objectType": "CONTACT",

    // The ID of the CRM object that is enrolled in the workflow
    "objectId": 4,
  },
  "inputFields": {
    // The property name for defined inputs
  },
  // A unique ID for this execution
  "callbackId": "ap-123-456-7-8"
}

import os
from hubspot import HubSpot
from hubspot.crm.contacts import ApiException

def main(event):

# How to use secrets

# Secrets are a way for you to save API keys or private apps and set them as a variable to use anywhere in your code

# Each secret needs to be defined like the example below

hubspot = HubSpot(access_token=os.getenv('SECRET_NAME'))

phone = '' try: ApiResponse = hubspot.crm.contacts.basic_api.get_by_id(event.get('object').get('objectId'), properties=["phone"]) phone = ApiResponse.properties.get('phone') except ApiException as e: print(e)

# We will automatically retry when the code fails because of a rate limiting error from the HubSpot API.

raise

# How to use inputs

# Inputs are a way for you to take data from any actions in your workflow and use it in your code instead of having to call the HubSpot API to get that same data.

# Each input needs to be defined like the example below

email = event.get('inputFields').get('email')

# How to use outputs

# Outputs are a way for you to take data from your code and use it in later workflows actions

# Use the callback function to return data that can be used in later actions.

# Data won't be returned until after the event loop is empty, so any code after this will still execute.

return { "outputFields": { "email": email, "phone": phone } }

# A sample event may look like:

# {

# "origin": {

# # Your portal ID

# "portalId": 1,

# # Your custom action definition ID

# "actionDefinitionId": 2,

# },

# "object": {

# # The type of CRM object that is enrolled in the workflow

# "objectType": "CONTACT",

# # The ID of the CRM object that is enrolled in the workflow

# "objectId": 4,

# },

# "inputFields": {

# # The property name for defined inputs

# },

# # A unique ID for this execution

# "callbackId": "ap-123-456-7-8"

# }

​

カスタムコードアクションを作成する

• HubSpotアカウントで、［自動化］>［ワークフロー］に移動します**。 **** **
• ワークフローの名前をクリックするか、新しいワークフローを作成します。
• +**プラス**アイコンをクリックし、ワークフローアクションを追加します。
• 左側のパネルで「カスタムコード」を検索して選択します**。 **

• デフォルトでは、カスタムコードアクションはNode.jsを使用します。Pythonベータ版でPythonを使ってアクションを作成する場合は、［言語］ドロップダウンメニューをクリックし、［Python］を選択します。
• ［説明］フィールドに、カスタムワークフローアクションの説明を入力します。_ _この説明は対応するワークフローアクションのカードに表示されます。
• カスタムコードアクションでは、非公開アプリのアクセストークンなどのシークレットを使用できます。アプリには、contactsやformsなど、HubSpotから取得しようとしているデータのスコープを含める必要があります。詳しくは、HubSpotの非公開アプリに関するぺージをご確認ください。
  • 既存のシークレットを使用するには、［シークレットを追加］をクリックします**。 次に、追加するシークレットの横にあるチェックボックス**をオンにします。
  • 新しいシークレットを追加する場合は、［シークレットを追加］をクリックします**。 **ダイアログボックスの［シークレット名］と［シークレット値］に値を入力します。次に、保存をクリックします。これで、以降のカスタムコードアクションでこのシークレットを選択できるようになります。
  • 既存のシークレットを編集または削除する場合は、［シークレットを管理］をクリックします**。 **
• カスタムコードにプロパティーを含めるには、次の手順に従います。
  • ［プロパティーを選択］をクリックし、データパネルからプロパティーを選びます**。 ワークフローでは、既存のプロパティーまたは以前に書式設定されたプロパティー値を使用できます。プロパティーを選択したら、コード内で使用するプロパティー名**を入力します。こちらで、カスタムコードでプロパティーを参照する方法をご確認いただけます。
  • 別のプロパティーを追加するには、［プロパティーを追加］をクリックします**。 **各プロパティーは1回のみ追加できます。また、プロパティーには固有の［変数ID］が割り当てられている必要があります。カスタムコードでは最大50個のプロパティーを使用できます。
  • プロパティーを削除するには、削除アイコンをクリックします。
• コードフィールドにJavaScriptまたはPythonを入力します。
• 例えば［レコードを編集］アクションなどで、後にワークフローにて入力として使用できるデータ出力を定義するには、次のようにします：
  • ［データ出力］で**［出力を追加］**をクリックします。
  • ［データタイプ］ドロップダウンメニューをクリックし、データのタイプを選択します。
  • ［名前］フィールドに、データ出力の名前を入力します。
  • 複数の出力を追加する場合は、**［出力を追加］**をクリックします。
• 上部にある**［保存］**をクリックします。

• コードスニペットのアクションが実行されると、def main(event):関数が呼び出されます。
• Event引数は、ワークフロー実行の詳細を含むオブジェクトです。
• ワークフローにデータを返すには、callback()関数を使用します。この関数は、exports.main関数内で呼び出す必要があります。これは、Node.jsでのみ使用できます。

//example payload
{
  "origin": {
    // Your portal ID
    "portalId": 1, // Your custom action definition ID
    "actionDefinitionId": 2
  },
  "object": {
    // The type of CRM object that is enrolled in the workflow
    "objectType": "CONTACT", // The ID of the CRM object that is enrolled in the workflow
    "objectId": 4
  },
  // A unique ID for this execution.
  "callbackId": "ap-123-456-7-8"
}

​

アクションのレート制限を設定する（ベータ）

• ワークフローのタイムラインで、カスタムコードアクションをクリックします。
• 下部にあるレート制限を設定をクリックして、レート制限セクションを展開します。
• ［レート制限をオンにする］スイッチをクリックしてオンに切り替えます**。 **デフォルトでは、この設定はオフになっています。
• レート制限を設定します。
  • アクションの実行: 1期間あたりの最大実行回数を設定します。
  • 期間: レート制限の期間を設定します。この期間は、「秒」、「分」、または「時間」に設定できます。

​

アクションのテストを行う

• ワークフローのプレビューで、［カスタムコードアクション］をクリックします**。 **
• 下部にある［アクションをテスト］をクリックしてテストセクションを展開します**。 **
• ［オブジェクト］ドロップダウンメニューをクリックし、テストするレコードを選択します**。 **
• ワークフローで過去に書式設定されたプロパティー値を使用する場合は、書式設定されたデータのテスト値を入力します。

• コードを実行するには、［テスト］をクリックします**。 **
• 表示されるダイアログボックスで、［テスト］をクリックして、選択したレコードに対してコードをテストすることを確認します**。 **
• コードの実行が完了すると、テストの結果が表示されます。
  • ステータス: カスタムコードアクションの成功または失敗のステータス。
  • データ出力: 定義されたデータ出力に対して得られた値。コードによって生成された、［データ出力］セクションでもコードエディターでも定義されていない出力の横にはアラートが表示されます。ワークフローで後で使用するには、これらの出力を追加する必要があります。
  • ログ: テスト自体に関する情報（アクションで使用されたメモリーの量、合計実行時間など）。
• アクションのテストが完了したら、［保存］をクリックして変更を保存します**。 **

​

シークレット

const hubspot = require('@hubspot/api-client');
exports.main = (event, callback) => {
return callback(processEvent(event));
};
function processEvent(event) {
// secrets can be accessed via environment variables
const hubspotClient = new hubspot.Client({
accessToken: process.env.secretName,
});
hubspotClient.crm.contacts.basicApi
.getById(event['object']['objectId'], ['email', 'phone'])
.then((results) => {
let email = results.body['properties']['email'];
let phone = results.body['properties']['phone'];
// ...
})
.catch((err) => {
console.error(err);
});
}

​

カスタムコードにHubSpotプロパティーを追加する

const email = event.inputFields['email'];

​

ログ記録

​

出力の定義方法

callback({
outputFields: {
email: email,
phone: phone,
},
});

• 出力するデータの型が文字列形式の場合、文字列の出力値の上限は65,000文字です。この制限を超えると、OUTPUT_VALUES_TOO_LARGEエラーが発生します。
• ［レコードを編集］アクションを使用している場合は、対応するソースプロパティーとターゲットプロパティーにご注意ください。
• 日付プロパティーを更新する場合
  • 出力を使用して日時プロパティーを更新する場合、出力はUNIXミリ秒形式である必要があります。
  • 日時プロパティーではなく日付プロパティーの更新に出力を使用する場合、出力はUNIXミリ秒形式である必要があり、かつ、日付の時刻が真夜中（UTC時間）に設定されている必要があります。

​

制限事項

​

再試行

• Node.jsを使用している場合、レート制限エラーが発生してもHubSpotに呼び出しを再試行させるには、カスタムコードアクションのcatchブロックでエラーをスローする必要があります。

• Pythonを使用している場合、レート制限エラーが発生してもHubSpotに呼び出しを再試行させるには、カスタムコードアクションのexceptブロックでエラーを報告する必要があります。

​

注意事項

• 乱数の生成: 乱数を生成するにはMath.randomを使用するのが一般的ですが、異なる実行で同じ数値が生成される場合があります。これは、Math.randomは現在の時刻でシードされるためです。HubSpotは、多数のオブジェクトを同時にワークフローに登録し、実行ごとに状態をクリアするため、異なる実行でMath.randomへのシードが同じように行われる結果になります。代わりに、random-number-csprng 1.0.2（英語）ライブラリーを使用すると、暗号論的疑似乱数の生成が保証されます。
• **変数の再利用:**メモリーを節約するには、exports.main関数の外部で宣言した変数を、カスタムコードアクションの以降の実行で再利用できます。これは、データベースなどの外部サービスに接続する場合に便利ですが、カスタムコードアクションの実行ごとに一意でなければならないロジックや情報は、exports.main関数に含める必要があります。

• 変数の再利用: 上記と同様に、def main関数の外部で宣言した変数は、カスタムコードアクションの以降の実行で再利用できます。
  • def main関数の外部で変数を宣言した場合、その変数に対するアラートを計画していないとしても、変数を直接参照できます。
  • 変数のアラートを計画する場合、その変数を参照する前にグローバルキーワードを使用したdef main関数内で変数を宣言できます。

a = 1
def main(event):
  global a
  a += 1