Developer Hub - Webhooks
Link: https://support.brilliantdirectories.com/support/solutions/articles/12000083005
Overview
Webhooks are one of a few ways web applications can communicate with each other. It allows to send real-time data from one application to another whenever a given event occurs.
The Webhooks functionality can be used to send data to any URL endpoint. This allows for sending data to intermediaries (Zapier, Pabbly Connect, Wokato, APIFuse, etc), API endpoints on other platforms, or custom endpoints created by the user to receive data.
To learn how to connect a webhook through Zapier see: Connecting Webhook Events With Zapier
For Smartlist Webhooks and how to connect them see: How To Create Smart List Webhooks
Webhooks
To set up a form to send submitted data to a custom Webhook URL, navigate to the Developer Hub >> Webhooks.
Available Webhook Events - Event Name
A "Webhook Event" is the action that triggers data to be sent to a Webhook Link (URL). The following Webhook Events are currently supported.
Actions
The actions column is going to display Edit and Delete options for Custom Webhooks. Default Webhook Events can't be deleted.
Event
A user submitting the following forms will trigger the data submitted in those forms to be sent to the Webhook Link in addition to its normal functionality.
Here is a full list of the available default webhooks and a description of their respective event:
Member Review Submitted
User submits a review for a member [form=member_review]
Contact Us Form Submitted
User submits the Contact Us form on the site [form=contact_form]
Newsletter Signup
User submits the Newsletter Signup form on the site [form=newsletter_modal_signup]
Lead Submitted
User submits the lead form [form=bootstrap_get_match]
Paid Plan Signup (On-Site Payment Gateway)
Member signs up for a paid Membership Plan through the frontend of the site using an On-Site Payment Gateway [form=whmcs_signup_paid]
Paid Plan Signup (Off-Site Payment Gateway)
Member signs up for a paid Membership Plan through the frontend of the site using an Off-Site Payment Gateway [form=whmcs_signup_external]
Free Plan Signup
Member signs up for a free Membership Plan through the frontend of the site [form=signup_free]
Members Imported / Added / Updated / Deleted Via Admin
Member is imported via CSV file in the Admin, member is added manually in the Admin, member's data is updated through the Quick Edit form in the Admin, or member is deleted in the Admin
Post - Standard
Member creates or edits a post of the following types: Videos, Articles, Blog Articles, Jobs, Events, Coupons, Audios, Discussions
Post - Photo Album
Member creates or edits a post of the following types: Photo Albums, Digital Products, Products, Classifieds, Properties
Sub Account Form Submitted
Member creates a sub-account using the Multi-Member Manager Add-On
Contact Details Form Submitted
Member submits the Contact Details form in the Member Dashboard [form=member_contact_details] & [form=contact_general_user]
Additional Details Form Submitted
Member submits the Additional Details form in the Member Dashboard [form=member_listing_details]
About Me Form Submitted
Member submits the About form in the Member Dashboard [form=about]
Profile Photos Form Submitted
Member submits the Profile Photo form in the Member Dashboard (uploads or edits their profile photo, logo, or cover photo)
Member Clicked Email Verification Link
Member clicks on the verification link sent in the "basic-validation" email template, typically after signing up for a free plan (Email variable: %confirm_link%)
Member Plan Changed
Member upgrades or downgrades their Membership Plan in the Member Dashboard
Member Plan Cancelled
Member cancels their account from the Member Dashboard
One-Time Purchase
Member purchases a Lead, Pay Per Post, or Digital Download
Post Comment Submitted
Member submits a comment on a post
Smart Lists
Allows sending data added to Smart Lists of different Types from the My Members > Smart Lists & Tags page in the Admin. Available Smart List types: Form Inquiries, Reviews, Leads, Members, and Transactions
Unsubscribed Form Submitted
User submits the Newsletter Unsubscribe form [form=unsubscribe_email]
Chat Message Actions
User submits a chat message using the Private Member Chat Add-On
Member Dashboard Payment
Member pays an invoice manually from the Member Dashboard
System Invoice Action
System automatically collects a recurring subscription payment during the daily cronjob
Admin Subscription / Invoice Action
Admin creates a new subscription, modifies an existing subscription, refunds an invoice, or modifies an invoice manually in the Admin area
Lead Accept / Decline
Member accepts or declines a lead in the Member Dashboard
+ Custom Forms
User submits the designated custom form
Note: Custom versions of the Contact Details + Additional Details + About Forms using a different variable and name are going to appear when creating a custom webhook when clicking on "New Webhook +".
Category
The category column explains what is the form that will send the data to the webhook.
Enable Webhook?
Toggle On - Off to enable or disable the Webhook.
Webhook Link
Enter the full URL of the endpoint the data should be sent to when the corresponding Webhook Event is triggered.
