Using Webhooks on InEvent

In this article, we will guide you through the steps to use Webhooks on the InEvent platform. Webhooks allow you to automate certain processes, such as sending data to external systems or triggering custom actions based on events within the platform.

What are Webhooks?

A Webhook is a mechanism that allows an application to send real-time information to other applications or services. It is essentially a URL that a third-party system can use to receive automated updates whenever an event occurs in another system. These updates contain information about the event that occurred, such as a new user registration or a ticket purchase.

Using Webhooks on InEvent

InEvent provides Webhook functionalities, which allow you to receive real-time notifications when certain events occur on the platform. For example, you can receive a webhook notification when someone enrolls or unenrolls from an activity in your event. You can also use these webhooks to trigger actions in other systems or to update your own internal systems.

Getting Started

To use Webhooks on InEvent, you will need to create a Webhook endpoint. A Webhook endpoint is a URL that InEvent will send your Webhook updates to.

After creating your Webhook endpoint (or URL), complete the following steps to integrate the Webhook with InEvent:

1. Log in to your InEvent account and navigate to your Event Level.
2. Click on the API symbol (</>) at the bottom right corner of your screen.
3. Choose the Webhook option from the left panel.

Adding a Webhook to InEvent

To add a Webhook to the platform, you can use the webhook.create method. This method takes in the Webhook endpoint URL and the request type as arguments.

The platform supports two request types as follows:

• activityEnrollment: handles requests for activity enrollments.
• activityDismissal: handles requests for activity dismissals.

To add a new Webhook to the platform, complete the following steps:

1. Click on the juice icon next to webhook.create.
2. Enter your Webhook endpoint URL into the url field.
3. Enter the request type into the type field.
4. Press the Enter button on your keyboard.

Finding a previously added Webhook

To find a previously added webhook, you can use the webhook.find method. Click on the juice icon next to the webhook.find method to see all webhooks added within your event.

For each Webhook, the webhook.find method displays the following pieces of information in json format:

• WebhookID: The ID that is automatically assigned to the Webhook by the platform.
• eventID: Your event ID (automatically assigned by the platform.)
• type: The Webhook request type.
• url: The Webhook endpoint URL.
• date: The date the Webhook was created, stored as a timestamp in string format.

Removing a Webhook from InEvent

To remove a Webhook from the platform, you can use the webhook.remove method. The method takes the WebhookID as an argument.

Complete the following steps to remove a Webhook from the platform:

1. Click on the juice icon next to the webhook.remove method.
2. Enter the WebhookID of the Webhook you would like to remove into the WebhookID field.

1. Press the Enter button on your keyboard.

Checking Webhook Request and Response examples

To test your Webhooks, InEvent provides options for you to see examples of your Webhook requests and responses. The webhook.requestExample and webhook.responseExample methods allow you to see what your Webhook request and responses will look like in json format.

Both the webhook.requestExample and webhook.responseExample methods take the WebhookID as an argument.

To see your Webhook request and response examples, complete the following steps:

1. Click the juice icon next to any of the methods (depending on your use case).
2. Enter the WebhookID into the WebhookID field.

1. Press the Enter button on your keyboard.