Skip to content

Commit cc2bfc5

Browse files
committed
wip: add quickstart to main readme
1 parent 8fad4b4 commit cc2bfc5

File tree

1 file changed

+53
-1
lines changed

1 file changed

+53
-1
lines changed

docs/contributing/README.md

+53-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,56 @@
1-
# EventKit
1+
# Outpost
2+
3+
TODO: What is outpost?
4+
5+
## Get Started
6+
7+
Start the Outpost dependencies and services:
8+
9+
```sh
10+
make up
11+
```
12+
13+
Create a tenant:
14+
15+
```sh
16+
curl --location --request PUT 'localhost:4000/api/v1/<TENANT_ID>' \
17+
--header 'Content-Type: application/json' \
18+
--header 'Authorization: Bearer <API_KEY>'
19+
```
20+
21+
Run a local server or use a hosted service such as the [Hookdeck Console](https://console.hookdeck.com?ref=github-outpost) to capture webhook events.
22+
23+
Create a webhook destination where events will be delivered to:
24+
25+
```sh
26+
curl --location 'localhost:4000/api/v1/<TENANT_ID>/destinations' \
27+
--header 'Content-Type: application/json' \
28+
--header 'Authorization: Bearer <API_KEY>' \
29+
--data '{
30+
"type": "webhooks",
31+
"topics": ["*"],
32+
"config": {
33+
"url": "<URL>"
34+
},
35+
"credentials": null
36+
}'
37+
```
38+
39+
curl --location 'localhost:4000/api/v1/hookdeck/destinations' \
40+
--header 'Content-Type: application/json' \
41+
--header 'Authorization: Bearer apikey' \
42+
--data '{
43+
"type": "webhooks",
44+
"topics": ["*"],
45+
"config": {
46+
"url": "https://hkdk.events/p2mjk25ge583vv"
47+
},
48+
"credentials": null
49+
}'
50+
51+
52+
53+
## Contributing
254

355
- [Getting Started](getting-started.md)
456
- [Test](test.md)

0 commit comments

Comments
 (0)