PDFフォーム送信の通知用にWebhookを設定する方法

Profile picture of Benjamin André-Micolon

送信データをアプリケーションに送ったり、SimplePDFをZapierActivepiecesなどのサービスと接続する強力な方法として、Webhookがあります。

Webhookとは?

Webhookは、特定のイベントが発生するたびに、あるアプリケーションから別のアプリケーションにリアルタイムでデータを送信することで、アプリケーション同士を接続する仕組みです。

SimplePDFでは、PDFが送信されるたびにフォームリンクまたはウェブサイトへの埋め込みを通じて、ドキュメント名や送信URLなどの情報を含むイベントが送信されます。

そこからは可能性は無限大です。

たとえば、その情報をGoogleスプレッドシートに保存したり、ZapierActivepiecesと連携してさらに多くの可能性を引き出すことができます!

SimplePDFでWebhookを設定する

Webhookの設定はBASICプランでご利用いただけます。

  • アカウントにログインします
  • アカウント設定画面に移動します

アカウント画面でWebhookを設定

  • Update configurationをクリックします
  • イベントを送信したいサービスやアプリケーションのWebhook URLを入力します

Webhook設定:設定詳細

  • 任意:Webhookの一部として送信するヘッダーを指定します

新しい送信があるたびにイベントが送信されるようになりました!

Webhookイベント

SimplePDFから設定したWebhookに送信されるイベントは以下の通りです。

  • 新しい送信

ペイロード

type: "submission.created",
data: {
  document: {
    id: "b7615a68-9e1f-4eac-bd20-5e80632a4d9e",
    name: "your_document.pdf",
  },
  submission: {
    id: "80146d5b-a068-490f-8eb9-fe393ba11396",
    submitted_at: "2023-06-04T11:54:58.995Z",
    url: "short_lived_15min_url",
  },
  context: {
    environment: "production",
    customer_id: "123"
  }
}

コンテキストについて

SimplePDFをウェブサイトに統合する際、送信に追加情報を関連付けたい場合があります。

たとえば、以下のようなことが可能です:

  • 送信が開発environmentからなのか、productionからなのかを把握する。
  • フォームを送信した_人物_に関する追加情報(ログインユーザーなど)を送信し、送信の処理を容易にする。

contextの指定方法については、SimplePDF embedのドキュメントをご覧ください。

プレイグラウンド

SimplePDFでは実例を大切にしています。Webhookが実際にどのように動作するか見てみましょう。

  1. 以下のコンテキストを編集してください(クリックして内容を編集できます
{"environment":"production","customer_id":"123"}
  1. このフォームを送信してください

  2. SimplePDFから送信されたWebhookがこちらに表示されます

ご質問がございましたら、お気軽にsupport@simplepdf.comまでご連絡ください。

あなたが興味を持つかもしれない