hook0-client 1.1.0

Rust SDK for Hook0 Open-Source Webhooks as a service for SaaS
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

# Hook0 Rust Client

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE.md)
[![Latest Version](https://img.shields.io/crates/v/hook0-client)](https://crates.io/crates/hook0-client)
[![Documentation](https://img.shields.io/docsrs/hook0-client)](https://docs.rs/hook0-client)

This is the Rust SDK for [Hook0](https://www.hook0.com), an open source Webhooks-as-a-Service platform designed for SaaS applications.

## Features

- **Send Events**: Send events to Hook0. (**producer**)
- **Upsert Event Types**: Make sure event types you use in your application's events are created in Hook0. (**producer**)
- **Verifying Webhook Signatures**: Ensure the authenticity and integrity of incoming webhooks. (**consumer**)

## Getting Started

To add the Hook0 client to your Rust project, run `cargo add hook0-client` in your project's directory.

### Enabling Features

The client supports several optional features:

- `consumer` (**default**): Enable features related to webhook signature verification.
- `producer` (**default**): Enable features related to upserting event types and sending events to Hook0.

## Examples

### Actix Web Example

The `examples/actix-web.rs` file demonstrates how to set up a simple [Actix Web](https://actix.rs/) server to handle webhooks signature verification.

This example starts a server listening on `127.0.0.1:8081` and handles incoming POST requests to the `/webhook` route. It checks webhooks signatures of incoming HTTP requests and displays information in the standard output.

## What is Hook0?

**Hook0** is an open source product that helps any software system (such as Software-as-a-Service applications) to expose webhooks to their end users.

Want to know more? Check out our [detailed documentation](https://documentation.hook0.com/docs/what-is-hook0) or visit our [website](https://hook0.com).

## Authors

- David Sferruzza - [david@hook0.com](mailto:david@hook0.com)
- François-Guillaume Ribreau - [fg@hook0.com](mailto:fg@hook0.com)

For more information, visit our [homepage](https://www.hook0.com/), join our [Discord community](https://www.hook0.com/community) or contact us at [support@hook0.com](mailto:support@hook0.com)

### LICENSE  
Hook0 Rust SDK is free and open-source. It is released under the [MIT License](./LICENSE.md).  

This license grants you the freedom to use, modify, distribute, and sublicense the SDK with minimal restrictions. You may use it in both open-source and commercial projects, as long as you include the original copyright notice.  

For more details, refer to the full [LICENSE.md](./LICENSE.md) file.