Webhooks are a useful tool in Harvestr to be notified of events occurring within the platform. They operate by sending normal HTTP requests with a JSON payload to a URL of your choice. This payload includes the changes on the mutated entity.
Available Webhooks
There are different webhooks available in Harvestr:
message_created: This webhook is triggered when a new message is created in your Harvestr inbox.message_updated: This webhook is triggered when a message is updated.discovery_created: This webhook is triggered when a new discovery is created.discovery_updated: This webhook is triggered when a discovery is updated.component_created: This webhook is triggered when a new component is created.component_updated: This webhook is triggered when a component is updated.feedback_created: This webhook is triggered when new feedback is created.feedback_updated: This webhook is triggered when feedback is updated.
Set up Webhooks
Setting up your endpoint URL
To arrange your Webhook subscriptions, head to your Harvestr Webhooks settings and click Add a new Webhook to organization.
Firstly, you'll need to designate the endpoint URL that will receive notification requests. Input your complete endpoint URL, which must utilize HTTPS, into the provided field.
This URL will get the HTTP POST notification requests for each topic you've subscribed to.
When you input your endpoint URL, click Validate and we will send a test request to validate it.
There are Webhook testing tools available online such as ngrok that can help create endpoint URLs for testing and experimenting.
To add an extra level of security, you can also add an HMAC signature along every request.
Subscribe to organization events
Next, you'll need to select the events for which you want to receive notification requests. When you are done, hit save and the webhook will be created. As a result, you will receive notification requests for all of the events you've subscribed to.
Deleting a Webhook
On your Webhooks page, click the Bin icon on the extreme right of the Webhook you wish to delete.