Webhooks are a way for applications to communicate with each other in real-time. They allow one system (in this case, Humaans) to send automated messages or information to another system when a specific event occurs.
Webhooks are currently available for all users with Owner permissions.
Before you begin
We recommend working with your IT/Engineering team before creating the Webhook on Humaans end. They can help you confirm the following information:
Which events you wish the webhook to have access to.
A Test endpoint URL that can be used to make sure your endpoint can successfully receive the configured events. Note we never send sensitive information, dummy data is used for all testing purposes.
The Production endpoint URL that Humaans will send the event information to - this will receive your Humaans data once the webhook is published.
Creating webhooks
In the Home menu, click Settings, then click Webhooks.
Select which events you want to include within the webhook. You can add in all events at once, or specify individual events to include by checking the associated checkboxes. Click Next step once you've selected the desired events.
Add a Test endpoint URL. This is used to make sure your endpoint can successfully receive the events you selected in the first step. As a note, we never send sensitive information - dummy data is used for all testing purposes. Click Next step once you're ready.
Add a Production endpoint URL. Configured events will be sent to this endpoint once published. This means that sensitive data will be included. Click Review webhook once you're ready.
The last section allows you to review the webhooks settings. When you're ready, click Publish webhook. Confirm by clicking Confirm and publish webhook.
Editing webhooks
If you ever have to make any changes to a webhook, you can go back and edit it.
In the Home menu click Settings, then click Webhooks.
Click on the desired webhook, then click Edit webhook in the top right-hand corner.
Navigate the webhook settings in the left hand corner, and make any changes to events, names, or URLs as needed.
When you are ready, navigate to Review and publish, and click Publish webhook. If there are no changes made to webhook, the option to publish will be greyed out.
Changes will be made once you click Confirm and publish webhook in the pop-up window.
Pausing and deleting webhooks
You may want to temporarily or permanently disable the webhook you previously created. You can do this with the following steps.
In the Home menu click Settings, then click Webhooks.
Click on the desired webhook, then click the ... icon in the top right-hand corner.
To temporarily stop the webhook, click Pause webhook. Commit to the change by clicking Confirm and pause webhook.
To permanently remove the webhook, click Delete webhook. Commit to the change by clicking Confirm and delete webhook.