How may we help?

Need to update or modify an existing webhook in OnlineFundraising? Follow this step-by-step guide. If you’d like help creating a new webhook instead, read the following guide: How to create a new webhook.

1. Go to the Webhooks Module 

Click Webhooks in the main menu on the left in OnlineFundraising. This will open the module, where you can view a list of your existing webhooks.

2. Find the webhook you want to edit

You’ll see a list of current webhooks, divided by Dataset API and Payment API. Locate the webhook you’d like to update and click on it.

3. Update (or deactive) the relevant webhook

In the edit window, you can adjust the following fields:

• Description:Update the description to make the webhook easier to identify.
  
• Endpoint: Enter a new URL where the data should be sent. Ensure it is accurate and prepared to receive data.
• API: Select whether the webhook should connect to the Payment API or Dataset API.
  • Payment API: Choose this option if you want to monitor events related to payment processes.
  • Dataset API: Choose this option if you only need to monitor datasets. Note that with the Dataset API, only two events are available:
    • Created: When a new dataset entity is created.
    • Updated: When an existing dataset entity is updated.
• Events: Select the specific events you want to track. The available events vary depending on the selected API.
  

For the Payment API, the following events are available:

• • • Created: When a new entity is created.
    • Updated: When an existing entity is updated.
    • 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 session ends.
    • Charged: When a payment is processed.
    • Refunded: When a payment is refunded.

For each event, you can select the specific entities to monitor:

• Contact: Track the creation or changes to contacts.
• Agreement: Monitor updates to agreements.
• Subscription: Follow changes to subscriptions.
• Payment method: See updates to payment methods.
• Payment: Track payment transactions.
• Addon: Monitor changes related to add-ons.

For the Dataset API, the available events are:

• • • • Created: When a new dataset entity is created.
      • Updated: When an existing dataset entity is updated.

You may also choose to Deactivate the webhook on the right side if you wish to temporarily pause it. However, please be aware that deactivating a webhook may interrupt the information flow to your CRM and could impact existing agreements.

4. Save your changes

Once you've made the changes needed, click Update in the top right to save and activate the changes to your webhook.