Webhooks are a tool that allow you to send notifications outside of ChMeetings when something happens in Chmeetings. This is helpful when integrating with other services or creating workflows based on these notifications.
At the moment, webhooks are available for the following events:
- When People are created, updated, or deleted.
- When Contributions are created.
- When Contribution Funds are created, updated, or deleted.
- When an event attendant has checked in.
- When an event attendant has checked in for the first time.
The ChMeetings API rate is 100 requests per second.
To configure a webhook:
- Go to Settings > Integrations > Webhooks.
- Click Add Webhook.
- In the Add New Webhook window, enter the Endpoint URL where notifications should be sent.
- Next, select the Events to listen to. You can choose to send notifications when People are created, updated, or deleted; when Contributions are created, or when Contribution Funds are created, updated, or deleted, and when an event check-in occurs.
- Save your webhook when done.
Once the webhook is created, you will see it listed, and you can edit or delete it.
When editing a webhook, you can also retrieve the Secret Key, which you can use to distinguish calls coming from ChMeetings. You can also disable the webhook, as needed.
If you want to delete a webhook, you must confirm your choice, keeping in mind that deleted webhooks cannot be restored.
Note For Diocese Accounts If you are using Webhooks with a Diocese account, the webhook will only listen for events that occur within the same account level as the Webhook integration. For example, if you integrate a people creation webhook in the main Diocese account, then it will only trigger when a profile is added within the main Diocese account and its direct ministries - not in any church account. Churches are autonomous - so if you want a webhook to trigger for a specific church, then you must integrate it within that church’s account. The webhook will listen for events (e.g. profiles created) within the church and its direct ministries, but not in the Diocese or any other church account. |