Intervengine Docs

Intervengine App

Coaching Tutorials

Experience Building Tutorials

Pre Built Journeys

Intervengine x Sahha

Releases

Book a Demo

Report an Issue

<aside> ☝

Webhooks are automated messages sent from Intervengine to your other applications when a specific event occurs. While they can be used for simple notifications, their primary purpose is system integration.

</aside>

The fundamental rule is: when a selected event happens in Intervengine, the system will instantly send a data payload to a specific URL you provide. This allows your external systems to react to actions in real-time, without needing to constantly ask our system if anything new has happened.

<aside> 💡

Example Imagine you need to keep your main customer database or CRM (Customer Relationship Management) system automatically synchronized with Intervengine.

• You create a webhook and in the Target URL field, you paste the unique web address provided by your CRM.
• You then select the Event Types you want to listen for, such as Participant Created and Participant Profile Updated.
• Now, when a new participant joins Intervengine, their data is instantly sent to your CRM, which automatically creates a new contact. If a participant later updates their profile, the webhook triggers again, and your CRM updates the existing contact record. </aside>

The Secret Key

A special, confidential Secret Key is automatically generated for every webhook you create. This key is sent along with every notification, allowing your receiving application to verify that the data is genuinely from Intervengine and has not been tampered with. It's a critical tool for ensuring your integration is secure.

The Data Payload

The data sent by a webhook is formatted in a standard structure (JSON) that is easy for other systems to read. It contains all the relevant information about the event that occurred, such as the participant's details or the content of a message.

Webhook Details

When you create a webhook, you must specify its configuration:

• Name: A simple label for you to easily identify the webhook's purpose (e.g., "CRM Sync").
• Target URL: The destination web address where the data payload will be sent.
• Event Types: The specific triggers you want the webhook to listen for, such as Message Sent or Participant Tags Added.

Using Webhooks

When you create and save a webhook, you must securely copy the Secret Key. You then need to configure your external application (like your CRM) to listen for incoming data at the Target URL and use the Secret Key to validate each request it receives.