Webhooks
Funraisin has the ability to send out data payloads via webhooks, which can be setup an configured from within the admin itself. A common use for webhooks is to send data to an external source e.g. Zapier, however another more powerful use of webhooks is to send data back to Funraisin itself via the Custom Controller so you can perform custom functions based on certain criteria.
Note that webhooks only fire from changes on the front end of the website, admin changes will not fire any webhooks.
Below is a list of all current webhooks.
Account Creation
The account creation webhook is fired for all online, offline and DIY events at the time when an entrant account is first created.
The payload send is the entire members table and the format is JSON and for online events it will send the entire members table plus the members_history table combined.
Registration Complete
The registration complete webhook fires when a fundraiser completes their registration for an online, diy or offline event.
The payload sent is the entire members table plus the members_history table in JSON format.
Team Creation
The Team Creation webhook, naturally fires as soon as a team has been created whether it be as part of a registration process or created from within the fundraiser's dashboard.
The payload sent is the entire Teams table sent in JSON format.
Account Update
The account update webhook is fired when an entrant or fundraiser updates their record both whilst registering or from within the fundraiser's dashboard in the My Account section.
The payload send is the entire members table and in some cased adding in the members_history table (non DIY) and the format is JSON.
Team Updated
The Team Creation webhook, naturally fires as soon as a team has been updated whether it be as part of a registration process or created from within the fundraiser's dashboard.
The payload sent is the entire Teams table sent in JSON format.
Organisation Page Created
The Organisation Page Creation webhook, naturally fires as soon as an organisation page has been created whether it be as part of a registration process or created from within the fundraiser's dashboard.
The payload sent is the entire Organisation Pages table sent in JSON format.
Organisation Page Updated
The Organisation Page Creation webhook, naturally fires as soon as an organisation page has been updated whether it be as part of a registration process or created from within the fundraiser's dashboard.
The payload sent is the entire Organisation Pages table sent in JSON format.
Donation
A donation webhook fires when a donation is made (online and sponsored donations only). This won't fire when someone makes a personal donation as part of a registration as that will be contained in the registration webhook.
This will send across the entire Donation record in JSON format.
Webform
In addition to sending across standard structured data, you can setup webhooks to send across specific webforms where you get sent all data relating to the chosen webform.
Event Created and Updated (DIY Only)
Webhooks relating to events are for DIY events only as they will send the event payload when a fundraiser creates or updates their DIY event.
This will send across the entire Event record in JSON format.
