WebhookでエントリーIDを送信する方法

はじめに

WebhooksアドオンでエントリーIDを送信しますか？フォームが送信されると割り当てられるエントリーIDは、WPFormsのエントリーを外部のCRMと相互参照するためにリンクする際に重要な役割を果たします。このチュートリアルでは、簡単なPHPスニペットを使ってこのプロセスを説明します。

フォームの作成

まずはフォームを作成し、必要なフィールドを追加しましょう。フォームの作成方法がわからない場合は、こちらのドキュメントを参考にしてください。

ウェブフックの設定

WebhooksでエントリーIDを送信するには、まずWebhooksアドオンを有効にする必要があります。Webhooksアドオンの設定についてサポートが必要な場合は、こちらの記事をご覧ください。

アドオンを有効にするには、フォームビルダーに移動し、[設定]をクリックし、[Webhookを有効にする]をクリックします。Webhook URL を入力し、フォームフィールドをリクエストボディにマッピングし、Webhook に含める情報を指定します。

スニペットの追加

次に、スニペットをサイトにコピーする。

スニペットをサイトに追加する方法や場所については、こちらのチュートリアルをご覧ください。

/**
 * Send the entry id through webhooks request.
 *
 * @link https://wpforms.com/developers/how-to-send-the-entry-id-through-webhooks/
 */

function wpf_dev_webhooks_process_delivery_request_options( $options, $webhook_data, $fields, $form_data, $entry_id ) {
    
	// Optional, you can limit to specific forms. Below, we restrict output to
    // form #1899.
    if ( absint( $form_data[ 'id' ] ) !== 1899 ) {
        return $options;
    }
	
	$body = ! is_array( $options[ 'body' ] ) ? json_decode( $options[ 'body' ], true ) : $options[ 'body' ];
	
	// Create a new entry and assign the entry_id
	$body[ 'entry_id' ] = $entry_id;
	
	// Format request data.
	if ( !empty( $options[ 'method' ] ) && $options[ 'method' ] !== 'GET' && $webhook_data[ 'format' ] === 'json' ) {
		
		// Encode request body.
		$options[ 'body' ] = wp_json_encode( $body );
	}
	
	return $options;
}

add_filter( 'wpforms_webhooks_process_delivery_request_options', 'wpf_dev_webhooks_process_delivery_request_options', 100, 5);

このスニペットでは、entry_idという変数を webhook に追加し、フォームが送信されたときに WPForms から作成されるこの ID 番号を代入します。フォーム ID 番号がどこにあるかわからない場合は、こちらのチュートリアルをご覧ください。

ウェブフックから送信された情報を見ると、マッピングされたフィールド名だけでなく、エントリーIDも表示されていることに気づくだろう。

これで完了です！これでエントリーIDをウェブフックに渡すことができます。Webhookでジオロケーション情報も送信したいですか？Webhookでジオロケーションを送信する方法の記事をご覧ください。