チュートリアル: HubSpot をソースとするワークフローの作成

Portant Developer API を使用して HubSpot をソースとするワークフローを作成する実践例です。すべてのリクエストは cURL を使用します。<DEVELOPER_ACCESS_TOKEN> は Portant インテグレーションチームから提供されたトークンに置き換えてください。

ヒント: 開始前に、Portant Workflow ウェブアプリでワークフローを作成して実行し、ワークフローの仕組みを把握しておくことをお勧めします。Google Docs テンプレートを使用することを推奨します。これにより、アカウントが Google の API に正しく認証されていることも確認できます。

このチュートリアルは、Developers overview ガイドの手順を完了済みであり、Portant アカウントがすでに HubSpot に接続されていることを前提としています。

Step 1. ワークフローの作成

ワークフローに「Developer Workflow」という名前を付け、HubSpot ソースを指定して Workflows POST エンドポイントで作成します。

curl --location --request POST 'https://api.portant.co/v0/workflows/' \
--header 'Authorization: <DEVELOPER_ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Developer Workflow",
    "source": {
        "sourceType": "HUBSPOT",
        "hubspotObjectTypeId": "0-3",
        "hubspotProperties": ["0-3.dealname", "0-1.firstname"]
    }
}'

HubSpot ソースでは、sourceType に加えて 2 つのフィールドが必要です。

hubspotObjectTypeId (String) このワークフローの主要な HubSpot オブジェクトタイプです。HubSpot 独自のオブジェクトタイプ ID 規則を使用します。たとえば 0-3 は Deal のオブジェクトタイプ ID です。完全な一覧については、HubSpot の object type ID reference を参照してください。

hubspotProperties (Array<String>) このワークフローのソースフィールドとして含めるプロパティです。各プロパティは <objectTypeId>.<internalFieldName> の形式で指定します。objectTypeId は上記のタイプ ID、internalFieldName は HubSpot におけるそのプロパティの内部名です。上記の例では、0-3.dealname でディール名を取得し、0-1.firstname で関連するコンタクトの名前を取得します。

リクエストが成功すると、新しいワークフローとともに 201 Created が返されます。id の値を保存してください。次のステップでテンプレートを追加する際に使用します。

Step 2. テンプレートの追加と公開

ここからのワークフローの動作は他のワークフローと同様です。残りの手順は Webhook チュートリアルと同一です。

Create a template document: 差し込み対象のファイルを追加します。
Listen for automation events: ドキュメントが作成されたときに通知を受け取ります。

ワークフローに HubSpot ソースと少なくとも 1 つのテンプレートが設定されると、status が "COMPLETE" になり、対応する HubSpot オブジェクトがトリガーされるたびに実行されます。

各エンドポイントおよびリソースの詳細については、API リファレンスの他のページを参照してください。ご質問や機能リクエストがある場合は、カスタマーサクセスチームまたはインテグレーションチームにお問い合わせください。