Webhooks Integration
Updated 3 days ago
by
Chioma Okenwa
InEvent offers a Webhook integration solution that allows you see and manage real-time webhook notifications when certain actions are carried out on the platform.
In this article, we will be showing you how to integrate your webhook on InEvent's platform in order to receive real-time information when specific actions are carried out.
What are Webhooks?
Webhook
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), you will be able to integrate the webhook with InEvent at the company level and event level.
What are the webhook events supported by InEvent?
Below is a table showing the webhook events that can be triggered from InEvent's platform.
Webhook event | Description | Action being triggered |
Event created This webhook event can be found only at the company level. | Triggers when an admin creates an event | Admin creates an event at the company level. |
Event admitted | Trigger when an admin edits an event. | Admin edits an event. |
Activity enrollment | Triggers when users register into an activity. | Attendee pins an activity in the My Agenda tab. |
Activity dismissal | Triggers when users deregisters from an activity. | Attendee unpins as activity in the My Agenda tab. |
Event enrollment | Triggers when users registers into the event | Attendee registers into the event via the Registration form. |
Event enrollment update | Triggers when users update their registration in the event. | Attendee updates their registration profile in the My Account tab or by admins in the People > Attendees page. |
Event dismissal | Triggers when a user deregisters from the event | Attendee is deleted from the event. |
Person checks in to the event | Triggers when user checks-in to the event | Attendee checks in to the event/ virtually joins an activity . |
Person checks in to an activity | Triggers when user checks-in to an activity. | Attendee joins an activity. |
Activity created | Triggers when an admins creates an activity | Admin creates an activity in the platform. |
Activity edited | Triggers when an admin edits an activity. | Admin edits an activity in the platform. |
Activity removed | Triggers when an admin removes an activity | Admin removes an activity from the platform. |
End of event | Triggers when an event is over. This is a timed webhook, it will only execute once per resource. | Event comes to an end. |
Adding Webhooks at the Company level
To add webhooks at the company level follow these steps:
- Go to Integrations > Webhooks.
- Click on +Add webhook and a new window will appear.
- Select the webhook event using the drop-down.
- Paste the webhook URL.
- Click on Create.
After creating your webhooks, it will be displayed on the Webhook dashboard. It will show the following:
- ID: The Id of the webhook.
- Event: The specific action being triggered.
- Description: The description of the webhook event.
- URL: The webhook URL.
To edit company webhooks, follow the instructions given here, and to remove a webhook, follow the instructions given here.
Viewing webhook logs at the company level
Once a webhook event has been acted upon/triggered, the information will appear in the Logs dashboard. To access it, click on Logs at the top right corner of the page.
You will see the following information:
- The log ID
- The Webhook ID
- The webhook event
- The Status
- The content - details of the log
- The Date and time the event was carried out.
Adding webhooks at the Event level
To add your webhooks at the event level, follow the following steps:
- Go to Settings > Integrations > Webhooks.
- Click on Webhooks from the menu on the left.
- Click on +Add webhook and a new window will appear.
- Select the webhook event using the drop-down.
- Paste the webhook URL.
- Click on Create.
After creating your webhook, you will see it displayed on the Webhook dashboard. It will show the following:
- ID: The Id of the webhook.
- Event: The specific action being triggered.
- Description: The description of the webhook event.
- URL: The webhook URL.
Can I edit the webhooks?
After creating the webhooks, you can modify them. To do this, simply click on the blue button beside a webhook and a new window will appear at the right. Click on Edit, and you will be able to:
- Change the webhook event by clicking on the drop-down and making a new selection.
- Change the webhook's URL.
Click on End to save your changes.
Removing a Webhook event
To remove a webhook, click on the blue button beside the webhook event you wish to remove. Click on the Delete button, and a confirmation window will appear. Type REMOVE WEBHOOK to confirm and click on Remove.
Viewing webhook logs at the event level
Once a webhook event has been acted upon/triggered, the information will appear in the Reports > Logs section.
On the Logs dashboard, you will see the following information:
- The log ID
- The Webhook ID
- The webhook event
- The Status
- The content details
- The Date and time the event was carried out.
Every webhook event being carried out on the platform will be automatically sent to the Webhook's URL.
