1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 1 year has passed since last update.

WorkatoAdvent Calendar 2023

Day 7

Workato:Custom Connectorの名称にマルチバイト文字や記号が含まれるとWebhookが動作しない場合がある

Last updated at Posted at 2023-11-22

はじめに

Workatoではカスタムコネクタ(Custom Connector)という機能があります。この機能を利用すると、Workatoが標準で対応していない=コネクタを提供していないアプリ(サービス)に対応するコネクタを独自に作成し、Workato上で運用(利用)することができます。

カスタムコネクタにおけるWebhook対応

カスタムコネクタはWebhookに対応しています。アプリケーション側がWebhookに対応していることは前提となりますが、アプリケーションからのWebhookリクエストをリアルタイム受信し、Triggerで処理することが可能です。例えば、〇〇というアプリでレコードを追加したら、それをきっかけ(トリガー)にWorkatoのあるレシピの処理を開始することも、Webhookを利用することで実現が可能です。

カスタムコネクタでWebhookを利用する際の注意事項

カスタムコネクタの名称には、マルチバイト文字(日本語等)や一部の記号など、URLエンコードされる文字列を含めないこと

カスタムコネクタの名称に日本語などのマルチバイト文字や一部の記号が含まれる場合、Webhookが正常に動作しない場合があります。例えば、アプリケーション側からWebhookリクエストが行われても、Workatoで処理されない(トリガーが動作しない)場合があります。

当方で確認したところ、URLエンコードされた文字列がカスタムコネクタのWebhook URLに含まれる場合、Webhookが動作しない(トリガーが動作しない)問題を確認しています。

例)タイトルにマルチバイト文字列を含む場合とそうでない場合のWebhook URLの違い

image.png

なお、カスタムコネクタのWebhook URLは、 最初に設定されたカスタムコネクタの名称をもとに決定されます。つまり、後からカスタムコネクタの名称を変更しても、Webhook URLは変わりません。 また、Webhook URLのみを個別に変更することもできません。

もし、上記のようなケースによりWebhookを利用することが出来ない場合は、同じ内容(コード)で、別名のカスタムコネクタの再作成が必要となります。

上記問題はCommunity Libraryや個別提供のコネクタでも発生する場合があります

Community Libraryよりカスタムコネクタをインストールする際や、配布元から個別提供を受けたカスタムコネクタ(Sharing privately using a linkより出力されたURL)をインストールする際も、カスタムコネクタの提供元が設定した名称以外にCustom Connectorを変更することでWebhookが正常に動作しなくなる場合があります。

カスタムコネクタの名称は、カスタムコネクタの提供元が設定した名称のまま(変更せずに)インストールして利用されることをお薦めします。もし、カスタムコネクタの名称を変更する必要がある場合は、マルチバイト文字(日本語等)や一部の記号を避けるようにしてください。もし不安がある場合は、カスタムコネクタの提供元に確認したうえでご対応ください。

1
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?