Test webhook notifications

Documentation | Checkbook

If you want to test the webhook flow, you can do that on our Sandbox environment really easily.

Set up the back-end code

You will need to have a server that can accept POST requests with the webhook payload. See the Webhooks section for more info.

If you just want to test the webhook flow before implementing your own server-side code, you can use a service like https://webhook.site

Configure the Webhook URL

You need to specify a the webhook URL in your developer settings in the Sandbox environment. If you used https://webhook.site, then you can paste "Your unique URL" into the "Webhook URL" fields in the Checkbook settings.

Test the webhook

You can use your favourite tool to make a POST call to our API, or even our interactive API reference. For this, just click on the "API Docs" button and you will be redirected to our docs page with your Sandbox api key pre-filled.

Then go to the webhook notification endpoint and enter a check id, select the status that you want to test for and click on "Try it". If the call is successful it will return a 204 status code with no content. This means the request was received by our servers and we'll make a POST call to the specified webhook callback URL.

If you used https://webhook.site, you can see the specified webhook was called by our servers with the desired payload. If you have your own server-side implementation, you should receive the same info.