Introduction
Webhooks in Realview Hub provide a powerful way to automate actions and integrate with external applications. By setting up webhook triggers, you can send real-time data to a specified URL whenever a particular event occurs within your Realview Hub account. This guide will walk you through the process of adding and managing these triggers.
Prerequisites
Access to Realview Hub with administrative permissions.
A target Endpoint URL where your webhook payload will be sent.
Basic understanding of webhook functionality for effective configuration.
Steps
1. Navigate to Webhook Settings
From the main Realview Hub dashboard, click on Settings (represented by a gear icon) in the top left corner.
In the left-hand navigation menu, scroll down and click on Webhooks. This will open the "Webhook Configuration" page.
2. Add a New Webhook Trigger
On the "Webhook Configuration" page, click the + New Trigger button located on the right side.
A "New Trigger" dialog box will appear, prompting you to configure the webhook.
3. Configure the New Trigger
Fill in the following fields in the "New Trigger" dialog:
Name: Enter a descriptive name for your webhook trigger (e.g., "New Order Notification").
Event: Select the specific event that will activate this webhook from the dropdown menu. Available events include, but are not limited to:
order_created(when an order is created)booking_rescheduled(when a booking is rescheduled)call_listing_added(when a call listing is added)call_listing_removed(when a call listing is removed)call_listing_switched(when a call listing is switched on a booking)landing_page_published(when a landing page is published)landing_page_unpublished(when a landing page is unpublished)landing_page_removed(when a landing page is removed)invoice_generated(when an invoice is generated)staff_profile_edited(when a staff profile is edited)equipment_assigned(when equipment is assigned)staff_requested_equipment(when a staff requests equipment)
Endpoint URL: Provide the full URL where the webhook payload will be sent (e.g.,
https://example.com/webhooks).Auth Type: Choose the authentication method required by your endpoint. The default is
none.Retries: Specify the number of times Realview Hub should attempt to resend the webhook if the initial attempt fails. The default is
1.Timeout (seconds): Set the maximum duration (in seconds) Realview Hub will wait for a response from your Endpoint URL. The default is
30.Signing Secret (optional): If your endpoint requires a signing secret for verification, enter it here.
Description: Add an optional description to further explain the purpose of this webhook.
4. Save the Trigger
After configuring all the necessary fields, click the Save button within the "New Trigger" dialog box.
The new trigger will now appear in the list on the "Webhook Configuration" page.
5. Manage and Save Changes
For each webhook trigger in the list, you can:
Enable/Disable: Use the toggle switch to activate or deactivate the webhook.
Send Test: Click the paper airplane icon to send a test payload to your Endpoint URL.
Edit: Click the pencil icon to modify the trigger's settings.
Delete: Click the trash can icon to remove the trigger.
Once you have finished adding or modifying your webhooks, click the Save Changes button at the top right of the main settings page to apply all configurations.
Tips
Leverage Events: Realview Hub offers a wide array of events to trigger webhooks, enabling extensive automation possibilities.
Technical Integration: For users with technical expertise, webhooks can be used to seamlessly integrate Realview Hub with various third-party applications and custom workflows.
Monitoring: Utilize the View Logs button on the "Webhook Configuration" page to monitor webhook activity and troubleshoot any delivery issues.
Conclusion
By effectively configuring webhooks in Realview Hub, you can automate critical processes, enhance data flow between systems, and extend the platform's capabilities to suit your unique operational needs.