Usage overview
Webhooks allow you to proactively subscribe to events that occur in your KnowledgeOwl account. When an event occurs that you have subscribed to, we will POST a message to the endpoint of your specification containing information about the event.
Currently we offer 2 types of POST payloads, one formatted specifically for the application Slack, and the other containing KnowledgeOwl API object data.
Create webhooks
You must have Full Admin access to create webhooks in your knowledge base.
To create webhooks in your knowledge base:
- Click on your profile icon/name in the upper right.
- Select Webhooks from the dropdown.
- Select the + Create New Webhook button to begin creating a new webhook.
+ Create New Webhook button
- This will open a New Webhook configuration pop-up:
New Webhook configuration pop-up
- The Knowledge Bases section allows you to select which knowledge bases you'd like this webhook to fire for. All Knowledge Bases is selected by default, but you can check individual knowledge bases to only enable it for specific knowledge bases.
- Select one or more Webhook Events. The events you select are what will trigger the webhook. See Available webhook events for more details.
- Select the Webhook Type:
- Slack will send the webhook as a Slack message. See Using Webhooks with Slack.
- API will send it to any API endpoint of your choice.
- Add an appropriate API Endpoint to send the webhook to.
- Click Create.
Here's an example of an API webhook configured to fire on the KnowledgeOwl Support knowledge base when an article is published or gets the Updated callout added to it:
Sample completed New Webhook configuration pop-up
Once you create the webhook, if you've selected a single knowledge base, you can also restrict the webhook to fire on a single category.
