Skip to content
HoW
Log inBook a demo
PlatformTenancyHelpContactLog inBook a demo
Help center

API keys and webhooks

For
church staff (the church's owner) and the church's developer
Status
Coming soon
Last reviewed

Coming soon: the API and webhooks work today; the Settings screen for making keys is on its way. Until then DCX Logic support makes a key or a webhook with you

On this page
  1. How it will work
  2. Good to know
  3. What DCX Logic support can do
  4. Coming from Planning Center

The API lets another system your church uses read and update your HoW records. Webhooks tell that system the moment something changes, such as a new person or a new registration.

How it will work

To make an API key

  1. In the staff dashboard, open Settings, then API keys, and choose New key.
  2. Name the key after the system that will use it, and choose the role or roles it should have. Tick Read only if that system never needs to change anything.
  3. Copy the key and give it to your developer. It is shown once. HoW does not keep it and cannot show it again.

To add a webhook

  1. Open Settings, then Webhooks, and choose New webhook.
  2. Enter the address your developer gives you (it must start with https://) and tick the events to send.
  3. Copy the signing secret, also shown once, and give it to your developer.

Good to know

  • A key can do what its role can do, and no more. It follows the same rules as a staff member with that role, including consent and children’s records. A key can never be an owner or an administrator.
  • Revoke a key the moment you stop using a system or think a key has leaked. It stops working at once.
  • Speed limit. 100 requests every 20 seconds per key.
  • Webhooks say what changed, not the details. The message names the event and the record; your developer’s system then asks the API for the record. A child’s name never travels in a webhook.
  • Events available: people, consent, form submissions, event registrations and store orders.
  • If your system is down, HoW tries again 16 times over about five days. After that the webhook is switched off and the church’s owners get an email. Turn it back on in Settings; Send again resends a single message.
  • History. Requests and webhook deliveries are kept for 30 days.
  • Limits. Up to 20 webhooks per church.
  • Plans. API access and webhooks are part of Elite and can be added to other plans.
  • For your developer: the technical reference is the HoW API guide, which DCX Logic sends on request.

What DCX Logic support can do

Switch the API and webhooks on for your church, make a key or a webhook with you until the screen arrives, and help your developer read a failed delivery. Support cannot recover a lost key or secret; make a new one instead.

Coming from Planning Center

Planning Center’s personal access tokens act as the person who made them, and its webhooks send the whole record. HoW’s keys act as a role you choose, and its webhooks send a pointer, so your developer adds one step: fetch the record after the webhook arrives.