api/webhooks¶
Webhooks allow to notify external services when a project analysis is done.¶
Examples¶
Create a Webhook.:
sonar.webhooks.create_webhook(name="My Webhook", url="https://www.my-webhook-listener.com/sonar")
or:
sonar.webhooks.create_webhook(name="My Webhook",
project="QXDevOPS:searchcode-server",
url="https://www.my-webhook-listener.com/sonar")
Delete a Webhook.:
sonar.webhooks.delete_webhook(webhook="AXQoj7QajOKlq86mQnzT")
Get the recent deliveries for a specified project:
deliveries = sonar.webhooks.get_webhook_deliveries(componentKey="my-project")
Get a webhook delivery by its id.:
delivery = sonar.webhooks.get_webhook_delivery(deliveryId="AXHAfha9dxfTzNWG9hAN")
Search for global webhooks or project webhooks. Webhooks are ordered by name.:
webhooks = sonar.webhooks.search_webhooks(project="my-project")
Update a Webhook.:
sonar.webhooks.update_webhook(webhook="AXQojxbgjOKlq86mQnzS",
name="My Webhook",
url="https://www.my-webhook-listener.com/sonar",
secret="your_secret")