You need at least 'Developer' rights in RaiseNow Manager to edit webhooks. More information about the different user roles can be found here
What are webhooks?
There are two ways to get information about a donation from a donor to an organization. On the one hand via the API (API user necessary) or via so-called webhooks. In the first case you pull the data, in the second case the data is sent (pushed) as soon as a defined event is triggered (e.g. donation was successful).
You can define an event, i.e. the occasion or time when you want to receive information about a payment from a donor. You also define the URL where the data should be securely transferred to. This way, the data can be processed further by third-party providers, e.g. CRM systems, email marketing tools and many more.
With webhooks you are currently informed about donation subscriptions (recurring payments) or one-time transaction state changes - as soon as a payment changes to a final status (see payment status).
The RaiseNow thank you emails after a successful donation are also triggered by webhooks.
Where can I define webhooks?
You can create your own webhooks in the RaiseNow Manager. Just go to the tab 'Actions & Events' and click on 'Webhook Configurations'. In 'Actions & Events' you can also check if the webhooks were successful for a specific transaction, more information here.
How do I create a webhook?
You create a new webhook by clicking on 'Create new webhook' in the upper right corner. After that you can configure the following:
- Merchant Configuration: For which configuration do you want to create a webhook (most of our customers will have only one here: Free or Growth).
- Event: At which event do you want to send the data? Consider here if you want to have data for successful payments, for example to send emails (final success) or possibly failed payments to do a follow up with the potential donor (final error). The available events are shown in a drop down menu.
- URL: To which URL should the data be sent?
- Username & Password: This is about data security. You don't necessarily need to set a username and password. If your system, which receives the data, makes a password request, make sure that the information is stored in the webhook.
- Testmode: Here you define if you want to have the data of productive payments or the data of a payment made in testmode.
- SSL Validation, Integrity Check, Security Level and Secure Response: You can mainly ignore this part. But if you define a username and password, you should set the Security Level to 'Basic'.
- Old format: We recommend to use the old format, because we are still working on the newer format.
How do I test a newly created webhook?
If you are not sure if your webhook is created correctly, you can use our tester to check it by sending random data to the endpoint you defined.
Go to the webhook you want to test. Click on the 'Tester' tab to the right of Configuration. There you can submit the webhook and below you can see the status, the test request and the response. If the response throws an error, something seems to be wrong with your webhook setup.
How do I delete webhooks?
You can delete webhooks at any time by clicking into the specific webhook and then clicking Delete in the upper right corner under Actions. For your info, you can also clone webhooks here.
Do you have more questions about webhooks? Contact us at firstname.lastname@example.org
Please sign in to leave a comment.