Webhooks
The Kentaa Connect Webhook service sends real-time messages to a customer defined URL when something happens on the Kentaa platform.
Example: POST https://example.com/foobar
The body of the message is sent as form parameters (Content-Type: application/x-www-form-urlencoded) or JSON (Content-Type: application/json). This is configurable per integration. The following attributes are present in the body:
| object_type | The object type (see object types table below). |
| object_id | The ID of the object. |
| event_type | The event type (see event types table below). |
| application | The application, always "Kentaa" or "Digicollect". |
| site_id | The ID of the site. |
Example request:
{
"object_type": "action",
"object_id": 42,
"event_type": "counters.update",
"application": "Kentaa",
"site_id": 12
}
With these attributes you can fetch the object using the Kentaa API or Digicollect API.
Object Types
See below, a list of the supported object types and a link to the related API to retrieve the object.
| Object Type | Kentaa API | Digicollect API |
|---|---|---|
| action | https://developer.kentaa.nl/kentaa-api/#actions | ‐ |
| collection_box | ‐ | https://api.digicollect.nl/v1/doc/collection-boxes#retrieve-a-single-collection-box |
| company | https://developer.kentaa.nl/kentaa-api/#companies | ‐ |
| donation | https://developer.kentaa.nl/kentaa-api/#donations | https://api.digicollect.nl/v1/doc/donations |
| donation_form | https://developer.kentaa.nl/kentaa-api/#donation-forms | ‐ |
| newsletter_subscription | https://developer.kentaa.nl/kentaa-api/#newsletter-subscriptions | https://api.digicollect.nl/v1/doc/newsletter-subscriptions |
| order | https://developer.kentaa.nl/kentaa-api/#orders | ‐ |
| project | https://developer.kentaa.nl/kentaa-api/#projects | ‐ |
| segment | https://developer.kentaa.nl/kentaa-api/#segments | ‐ |
| site | https://developer.kentaa.nl/kentaa-api/#sites | https://api.digicollect.nl/v1/doc/sites |
| team | https://developer.kentaa.nl/kentaa-api/#teams | ‐ |
| urgent_call | ‐ | https://api.digicollect.nl/v1/doc/urgent-calls |
Event Types
See below, a list of the support event types.
Kentaa Events
| Event Type | Description |
|---|---|
| actions.create | A fundraiser page has been added (usually through the dashboard; for registrations see sign_ups.create). |
| actions.move | A fundraiser page has been moved. |
| actions.update | A fundraiser page has been updated. |
| companies.create | A company has been added. |
| companies.update | A company page has been updated. |
| counters.update | Donation counter for an object has been updated. |
| donations.move | A donation has been moved. |
| donations.update | A donation has been created or updated (it's possible to get this message multiple times for the same donation, e.g.: 1. donation was created (payment status is pending). 2. donation was paid). |
| donation_forms.create | A donation form has been created. |
| donation_forms.publish | A donation form has been published. |
| donation_forms.update | A donation form has been updated. |
| newsletter_subscriptions.update | A newsletter subscription has been created or updated. |
| orders.update | An order has been created or updated (it's possible to get this message multiple times for the same order, e.g.: 1. order was created (payment status is pending). 2. order was paid). |
| projects.confirm | A project has been confirmed by the user. |
| projects.create | A project has been added. |
| projects.move | A project has been moved. |
| projects.update | A project has been updated. |
| questions.update | Extra questions for an object have been updated. |
| segments.create | A segment has been added. |
| segments.update | A segment has been updated. |
| sign_ups.create | The sign up flow was completed, one or more objects of the following types were created: action, company, donation, order, team. |
| teams.create | A team has been added. |
| teams.move | A team has been moved. |
| teams.update | A team has been updated. |
Digicollect Events
| Event Type | Description |
|---|---|
| collection_boxes.create | A collection box has been added. |
| counters.update | Donation counter for an object has been updated. |
| donations.update | A donation has been created or updated (it's possible to get this message multiple times, e.g.: 1. donation was created (payment status is pending). 2. donation was paid). |
| groups.create | A group has been added. |
| newsletter_subscriptions.update | A newsletter subscription has been created or updated. |
| urgent_calls.create | An urgent call has been created. |
Error handling
The webhook request is considered successful when you return the HTTP status 200 OK. When any other HTTP status is returned, the webhook will be retried with an increasing interval for a total of 24 hours before the message is discarded.