Reference - OnlineFundraising webhooks and what happens with them

Webhooks from OnlineFundraising

Entity

Event

Description

What we do with it (summary)

contact

created

The Contact was created.

Finds and updates / or adds a constituent, with link to the OF contact.

Duplicate prevented if existing constituent found with a match score of 13+.

 

updated

The Contact was updated.

 

archived

The Contact was archived.

Archive a constituent.

 

merged

The contact was merged into a target contact. This callback will be sent for the contact that is being archived.

Merges the constituents.

agreement

created

The Agreement was created.

Add or update an RPI.

 

updated

The Agreement was updated.

 

archived

The Agreement was archived.

N/A

paymentMethod

created

The Payment Method was created.

N/A

 

activated

The Payment Method was accepted by Contact

N/A

 

updated

The Payment Method was updated by Merchant

N/A

 

rejected

The Payment Method was rejected by Contact

N/A

 

cancelled

The Payment Method was cancelled by Merchant or Contact

N/A

 

failed

The Payment Method failed. Please see error description

N/A

 

expired

The Payment Method expired

N/A

 

sessionExpired

The Payment Method was expired. Used for MobilePay Subscriptions one-off that was not accepted in time.

N/A

subscription

created

The Subscription was created.

Add or update an RPI.

 

activated

The Subscription was set active.

Add or update an RPI.

 

updated

The Subscription was updated by Merchant.

Add or update an RPI.

 

expired

The Subscription period ended.

N/A

 

cancelled

The Subscription was cancelled by Merchant or Contact.

Sets an RPI to cancelled.

 

onHold

The Subscription was paused by Merchant.

Sets an RPI to paused.

 

restarted

The Subscription was restarted by Merchant.

Removes cancelled or paused from an RPI.

payment

created

The Payment was created.

If linked to a subscription an expected payment is Donorfy for the related RPI.

 

charged

The Payment was charged.

Add or update a transaction.

Complete an expected payment if linked to RPI.

 

sessionExpired

The Payment was expired. Used for MobilePay Subscriptions one-off that was not accepted in time.

N/A

 

rejected

The Payment was rejected by Contact.

Adds an activity that a payment was rejected.

 

cancelled

The Payment was cancelled by Merchant.

Adds an activity that a payment was cancelled.

 

refunded

The Payment was refunded by Merchant.

N/A

 

failed

The Payment failed.

Adds an activity that a payment has failed.

dataSet

created

The DataSet was created.

N/A

 

updated

The DataSet was updated.

N/A

addOn

created

The AddOn was created.

Creates or updates a payment and allocation on the RPI this addOn is related to.

 

updated

The AddOn was updated.

 

cancelled

The AddOn was cancelled

Sets the end date of the upgrade part of an RPI.

 

archived

The AddOn was archived.

N/A

Have more questions? Submit a request

Comments

Powered by Zendesk