Want to keep your external systems updated with the latest information from OnlineFundraising? Then you can set up a webhook in the Webhooks module – get an introduction to the module here. This guide provides step-by-step instructions on creating a webhook and details the information you’ll need.
1. Go to the Webhooks module
Click Webhooks in the main menu on the left in OnlineFundraising to open the module.
2. Create a new webhook endpoint
Click Add new on the left side to set up a new webhook endpoint to monitor the events you wish to track.
3. Fill out your webhook information
A window will now open with fields to complete.
Fill out the following information:
- Description: Add a short description of your webhook to make it easier to identify later.
- Endpoint: Enter the URL where data should be sent. Ensure this URL is correct and ready to receive data.
-
API: Choose whether the webhook should be linked to the Payment API or Dataset API:
- Payment API: Select this option to monitor payment-related events, such as agreements and transactions.
- Dataset API: Select this option if you want to monitor datasets.
-
Events: Choose the events you’d like to monitor. You can Select all to subscribe to all events or choose specific events.
If you have selected Payment API the following events are available:
- Created: When a new entity is created.
- Updated: When an existing entity is changed.
- Archived: When an entity is archived.
- Merged: When two entities are combined.
- Activated: When an entity is activated.
- Cancelled: When an entity is cancelled.
- Restarted: When an entity is restarted.
- Expired: When an entity expires.
- On hold: When an entity is paused.
- Failed: When an entity fails.
- Rejected: When an entity is rejected.
- Session expired: When a sessions ends.
- Charged: When a payment is processed.
-
Refunded: When a payment is refunded.
For each event, you can select the specific entities you’d like to monitor:
-
- Contact: Track creation or updates to contacts.
- Agreement: Monitor updates to agreements.
- Subscription: Follow updates to subscriptions.
- Payment method: See changes to payment methods.
- Payment: Track payment transactions.
-
Addon: Monitor changes related to add-ons.
Example: If you want your webhook to update an external system when a new contact is created, you can select Created and then tick Contact.
If you’ve chosen the Dataset API, you can select:
-
- Created: When a new dataset entity is created.
- Updated: When an existing dataset entity is updated.
4. Save your webhook
Once you’ve completed all fields, click Save at the top right to save and activate your new webhook endpoint.
If you want to adjust your webhook settings in the future, see the guide: How to edit an existing webhook.