Publish webhook or something similar

[jfro]

Was thinking it'd be nice to have kellnr hit a webhook or run a script upon successful publish, notifying of newly published crate/version to something like Slack.

[secana]

That's a cool idea and doesn't seem too much work. I'll look into it.

[secana]

To support a webhook we need:

• POST endpoint /api/v1/webhook to register a hook with register body
• DELETE endpoint /api/v1/webhook?id=x to remove a webhook
• GET endpoint /api/v1/webhook to list all registered hooks or /api/v1/webhook?id=x to get info about a specific hook
• All API calls have to be authenticated and only admin accounts are allowed
• A library that contains the events to be used to serialize and deserialize events. Public on crates.io
• Store all registered events in the database to be persistent
• Add UI to see registered hooks
• Add UI to register hooks
• Add UI to delete hooks
• Add documentation to https://kellnr.io for the webhook API

The register event needs to contain all relevant data for kellnr, to be able to call the client in case, a event occurs.

// register event
{
   "url": "the url that gets a POST event",
   "name": "optional name for the hook",
   "events": [
       "crate_add",
       "crate_update",
       "crate_delete"
    ]
}

If the register event was send to kellnr, it responses with a HTTP OK and an ID that the client can use to identify the hook.

In case of an event, kellnr sends a HTTP POST to the registered urls.
To distinguish the event types, append a parameter to the url, e.g. https://url?event=crate_add

// event
{
   "id": "x",
    "name": "optional name",
    "event": "crate_add",
     "data": {
     // relevant data for the event
     }
}

[secana]

The webhook API can be a first step to support a separate builder container, to keep the kellnr image small. If a new crate/version is uploaded, call a webhook to the builder container. #276

[secana]

Adhere to the https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md where possible