Introduction
Webhooks allow you to build or set up a web service (perhaps in relation to your CRM) which subscribes to certain events in OnlineFundraising.
When the listed events are triggered a HTTP POST payload is sent to the configured webhook URL from IPs listed here: https://s3.eu-central-1.amazonaws.com/dk.onlinefundraising.info/webhooks.json
Please note that webhooks may be delivered twice in rare occasions, if connection problems, bad timings etc. is experienced. Please also see delivery attempts below.
Event types
Below is a list of events triggering webhooks:
Entity |
Event type |
Description |
---|---|---|
contact |
created |
The Contact was created. |
|
updated |
The Contact was updated. |
|
archived |
The Contact was archived. |
|
merged |
The Contact was merged into a target Contact. This callback will be sent for the Contact that is being archived. |
agreement |
created |
The Agreement was created. |
|
updated |
The Agreement was updated. |
|
archived |
The Agreement was archived. |
paymentMethod |
created |
The Payment Method was created. |
|
activated |
The Payment Method was accepted by Contact |
|
updated |
The Payment Method was updated by Merchant |
|
rejected |
The Payment Method was rejected by Contact |
|
cancelled |
The Payment Method was cancelled by Merchant or Contact |
|
failed |
The Payment Method failed. Please see error description |
|
expired |
The Payment Method expired |
|
sessionExpired |
The Payment Method was expired. Used for MobilePay Subscriptions one-off that was not accepted in time. |
subscription |
created |
The Subscription was created. |
|
activated |
The Subscription was set active. |
|
updated |
The Subscription was updated by Merchant. |
|
expired |
The Subscription period ended. |
|
cancelled |
The Subscription was cancelled by Merchant or Contact. |
|
onHold |
The Subscription was paused by Merchant. |
|
restarted |
The Subscription was restarted by Merchant. |
payment |
created |
The Payment was created. |
|
charged |
The Payment was charged. |
|
sessionExpired |
The Payment was expired. Used for MobilePay Subscriptions one-off that was not accepted in time. |
|
rejected |
The Payment was rejected by Contact. |
|
cancelled |
The Payment was cancelled by Merchant. |
|
refunded |
The Payment was refunded by Merchant. |
|
failed |
The Payment failed. |
addOn |
created |
The AddOn was created. |
|
updated |
The AddOn was updated. |
|
cancelled |
The AddOn was cancelled. |
|
archived |
The AddOn was archived. |
dataSet |
created |
The DataSet was created. |
|
updated |
The DataSet was updated. |
Webhook payload
One or more webhook objects may be delivered in a single request.
Example of POST delivery
[
{
"merchantId": "onlinefundraising",
"webhookEventGuid": "22ce6765-461f-4dd2-a3eb-xxxxxxxxxxxx",
"webhookGuid": "592d0752-dfda-46b8-aeec-xxxxxxxxxxxx",
"webhookAttemptGuid": "029b8cb0-9825-466d-a9db-xxxxxxxxxxxx",
"entityGuid": "b1123c69-cb84-4adf-98cf-xxxxxxxxxxxx",
"entityType": "contact",
"eventType": "created"
},
{
"merchantId": "onlinefundraising",
"webhookEventGuid": "a1dfb689-3273-49b7-9f5f-xxxxxxxxxxxx",
"webhookGuid": "07a05b9b-a699-4bee-9afe-xxxxxxxxxxxx",
"webhookAttemptGuid": "89efde72-4c01-4dd7-89c6-xxxxxxxxxxxx",
"entityGuid": "8e449c62-9b9d-4776-a2da-xxxxxxxxxxxx",
"entityType": "payment",
"eventType": "updated"
}
]
Webhook delivery attempts
Should your integration not respond or respond with a HTTP code other than 200 OK we will resend the webhook by an exponential backoff algorithm with the following seconds interval per attempt:
- 10
- 1800
- 3600
- 5400
- 7200
- 9000
- 10800
- 12600
- 14400
- 16200