<commit_before># webhulk

[![Build Status](https://travis-ci.org/grvcoelho/webhulk.svg?branch=master)](https://travis-ci.org/grvcoelho/webhulk)

:construction: A lightweight API for managing webhooks<commit_msg>readme: add api<commit_after># webhulk

[![Build Status](https://travis-ci.org/grvcoelho/webhulk.svg?branch=master)](https://travis-ci.org/grvcoelho/webhulk)

:construction: A lightweight API for managing webhooks

## API

### Webhooks

| Attribute | Type | Description |
| --------- | ---- | ----------- |
| `name` | *String* | An indentifier for the webhook |
| `url` | *String* | The url messages will be sent to |
| `enabled` | *Boolean* | Whether or not it is enabled |


### Messages

| Attribute | Type | Description |
| --------- | ---- | ----------- |
| `headers` | *JSON* | The HTTP headers that will be sent |
| `payload` | *JSON* | The payload that will be sent |
| `signatures` | *String* | An HMAC signature of the message |

### Deliveries

| Attribute | Type | Description |
| --------- | ---- | ----------- |
| `status` | *String* | The status of the delivery. One of: `success`, `failed`, `processing` |
| `latency` | *JSON* | The time between the delivery and the response from the client |
| `response_status_code` | *String* | The HTTP status code the client respond with |
| `response_headers` | *JSON* | The HTTP headers the client respond with |
{'fraction_non_alphanumeric': 0.18985507246376812, 'fraction_numerical': 0.0, 'mean_word_length': 3.356466876971609, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3885976', 'n_tokens_mistral': 445, 'n_tokens_neox': 434, 'n_words': 129}