IN THIS ARTICLE:
Introduction to webhooks
Webhooks notify you about every prospect, campaign, or manual task-related event. Depending on which webhook you subscribe to, you'll receive information each time a desired event occurs.
Using webhooks requires API keys & integrations add-on. Click here to learn how to get it on Marketplace.
How it works?
You can either subscribe to webhooks by API or add them under the Marketplace -> Webhooks tab. The Webhooks tab is accessible to all users except Guest viewers.
In the “Webhooks” tab, click on the “Add webhook” button. You can then choose the webhook type:
Slack - so you get instant notifications sent directly to your Slack workspace,
Custom - so the JSON event data is sent to other systems.
In both of these options, you’ll have to name your webhook, paste the Webhook URL, and choose events to subscribe to. There’s a limit of subscribing to 5 webhooks per one event.
Slack notification
If you want to get notifications on your Slack workspace, you have to get the relevant Webhook URL.
First, create an App on Slack here. Select “From scratch” here:
Fill the App Name field and pick the name of your workspace to develop your app in from the dropdown list.
After this set up, in the “Incoming Webhooks” tab, switch the toggle to “On”, add new webhook to your workspace, and choose the Slack channel to which the webhooks should be posted.
After setting this up, copy the generated Webhook URL and paste it in Woodpecker.
Custom webhooks
For custom webhooks, name it in the “Webhook name” field, paste the URL from your domain, and choose events to subscribe to from the drop-down list. The webhook name is only for you to know what it refers to, we don’t use it publicly for anything else.
Editing and deleting webhooks
You can always edit webhooks after adding them. Click on the three dots icon next to the webhook name and choose “Edit.”
To delete a webhook, simply click on the three dots icon and choose to delete it. You can also select a few of them and delete them in bulk by clicking on the trash icon at the top of the table. This action cannot be undone.
FAQ
Q.: Who is able to manage webhooks on my account?
For single-company accounts, webhooks can be managed by all team members.
Q.: Will I be notified about an error regarding my webhook? How can I fix it?
In the Webhooks tab, if a certain webhook doesn’t work, it will be highlighted in red. To restart it, click on the webhook and edit its URL.
Q.: How will I know that the webhook is properly configured?
Webhooks work in pairs, and we always check if the added webhook has a unique pair of URL and an event. An example of a URL would be the address of your Slack channel, and as for the event, the prospect replied. We check if there’s already a webhook with the exact same URL and an event, and if yes, you won’t be able to add it again in case any information is duplicated.