Webhooks

Overview

Webhooks allow you to send notifications to servers outside of CloudRepo whenever one of the following events occurs in a Maven, Python or npm repository:

• File Deletion
• File Download
• File Upload

Caution

Docker repositories send no webhook events. The Create a Webhook form lists them, but a webhook attached to a Docker repository never fires: not on a push, a pull, or a delete. Attach a webhook to a Maven group’s member repositories, not to the group: a download through a group fires on the member that served it.

Types of Webhooks

CloudRepo currently supports the following type of Webhooks:

• JSON Webhooks
• Slack

Every webhook target must be an https:// URL that resolves to a public host.

Note

If you need additional webhook support, please let us know.

JSON Webhooks

CloudRepo can be configured to POST a JSON payload to an HTTPS endpoint whenever a file event happens in a Maven, Python or npm repository.

Jump to Creating a Webhook to get started.

Slack Integration

To send events to a Slack channel, create an incoming webhook in your Slack workspace first, by following Slack’s guide, Sending messages using incoming webhooks. Slack gives you a webhook URL. Then create a CloudRepo webhook of type Slack and paste that URL as the Webhook Target. Treat the URL as a secret: whoever has it can post to your channel.

Creating a CloudRepo Webhook

First, you’ll need to login to the CloudRepo Administrator Portal.

From the side navigation panel, click Webhooks.

You’ll be presented with the list of webhooks. If this is your first, the page reads No webhooks configured.

Click Create Webhook.

On the Create a Webhook screen, fill in:

• Repository to Trigger Webhook: the webhook fires for events in this repository.
• Webhook Target: for JSON, the https:// URL that listens for an HTTP POST with a JSON body; for Slack, the webhook URL you copied from Slack.
• The webhook type: JSON or Slack.
• Fire Webhook On the Following Artifact Events: tick Delete, Download, Upload, or any of them.

Then click Create Webhook.

Upon successful completion, your webhook will now be listed in the list of webhooks:

Modifying a Webhook

At this time, CloudRepo doesn’t support modifying an existing webhook.

If you wish to add events to a particular webhook URL, simply create a new webhook with the additional events you wish to monitor.

If you wish to remove events from a particular webhook, delete the existing webhook and add a new webhook with the updated permissions.

Deleting a Webhook

In order to delete a webhook, select it from the list of webhooks:

On the Webhook Details page, click Delete Webhook.

A confirmation window will pop up; confirm, and the webhook is permanently removed.