https://github.com/hookdeck/webhook-samples
A collection of example webhooks from popular platforms
https://github.com/hookdeck/webhook-samples
webhook-events webhooks webhooks-json
Last synced: 6 months ago
JSON representation
A collection of example webhooks from popular platforms
- Host: GitHub
- URL: https://github.com/hookdeck/webhook-samples
- Owner: hookdeck
- Created: 2023-02-08T18:52:28.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-12T20:38:25.000Z (over 1 year ago)
- Last Synced: 2024-09-13T10:23:31.802Z (over 1 year ago)
- Topics: webhook-events, webhooks, webhooks-json
- Language: TypeScript
- Homepage: https://samples.hookdeck.com
- Size: 306 KB
- Stars: 19
- Watchers: 2
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Webhook Samples
This repo is a collection of webhooks data from different platforms that distribute webhooks. This data is used in https://console.hookdeck.com "Example Webhooks".
## Contributing
### Adding a new provider
1. Add a new directory for the provider in `./providers`
2. Create a `index.json` file in that provider directory. The index.json file needs a `label` which is the publicly recognizable name for the provider, and a set of configs. The `latest_version` represents the most recent version for that provider, if the provider doesn't offer versioning then input `latest`. The `topic_identifier` is optional and represent either a header or body key to extract the topic from the request.
```
{
"label": "Shopify",
"configs": {
"latest_version": "2023-01",
"topic_identifier": "x-shopify-topic"
}
}
```
3. [OPTIONAL] Install the dependencies with `yarn` install` and start the request receiver with `yarn dev:receiver`. You can now send a request to http://localhost:9001/:provider/:version, and the received request will automatically be saved to that provider directory.
Each provider has a directory for each version, and each version has a file for each topic. The file's name is the topic and contains the request data `headers` and `body`.
You can manually enter the data if you'd instead not use the request receiver.
## Using the data
The data is packaged into JSON files that are distributed over http. The files can be found on https://samples.hookdeck.com
List of providers: https://samples.hookdeck.com/providers.json
Data for a provider: https://samples.hookdeck.com/providers/shopify/2023-01.json