How to set up a webhook

In this article, we will explain how you can set up a webhook within the WeGuide system, utilizing the capabilities of the medical API and health API for improved patient engagement in clinical trials.

Table of Contents

• Introduction
• Understanding Webhooks
• How to Set Up a Webhook
  • Step 1: Access the Integrations Page

Webhooks are automated messages sent from WeGuide to another application when an event occurs in the WeGuide system, allowing real-time data sharing and integration. They enable external application to communicate and trigger actions without the need to continuous poll the WeGuide system.

Within WeGuide, you can set up your own webhooks. Please ask your implementation manager to enable the integration for you. Once activated, please follow the steps underneath. 

Introduction

In this article, we will explain how you can set up a webhook within the WeGuide system, utilizing the capabilities of the medical API and health API for improved patient engagement in clinical trials.

Understanding Webhooks

Webhooks are automated messages sent from WeGuide to another application when an event occurs in the WeGuide system. This allows for real-time data sharing and integration, enabling external applications to communicate and trigger actions without the need to continuously poll the WeGuide system.

How to Set Up a Webhook

Within WeGuide, you can set up your own webhooks. Please ask your implementation manager to enable the integration for you. Once activated, please follow the steps below.

Step 1: Access the Integrations Page

• When you're logged in as an Administrator, please go to Settings → Integrations.
• Here, you will be able to set up your webhook:
  • URL: Enter the URL from your external website where the payload data should be sent.
  • Secret Key: Input the Secret Key that is required to send the payload data.
  • Status: Set the status to Active if you want the webhook to be triggered based on the selected events.
  • Events:Define which events should trigger the webhook. Currently, the following events are supported:
    • Participant created: The webhook will be triggered every time a participant is created in the WeGuide system.
    • Form completed: The webhook will be triggered every time a form is completed within WeGuide. If a form is partially completed but not finished, no event is triggered.

Complete the webhook details section within the Integration tab to setup your webhook. 

Was this article missing some information or unclear? Please click on thumbs down below and let us know how we can improve it! Your feedback is always appreciated.