Skip to content

Commit 32d80b0

Browse files
authored
Update README.md
1 parent 54addba commit 32d80b0

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ You can't point strapi webhooks to the [repository dispatch event endpoint](http
1414

1515
## Usage
1616

17-
Ensure your GitHub Actions workflow file handles the "repository_dispatch" event with your custom type:
17+
1. Ensure your GitHub Actions workflow file handles the "repository_dispatch" event with your custom type:
1818

1919
```yml
2020
name: Deploy
@@ -23,13 +23,15 @@ on:
2323
types: [strapi_updated]
2424
```
2525
26-
Deploy the service to your server, for example:
26+
2. Create a GitHub Personal access token with `repo` scope
27+
28+
3. Deploy the service to your server, for example:
2729

2830
```bash
2931
docker run --publish 5000:5000 --env GITHUB_TOKEN=YOURTOKEN ghcr.io/badsyntax/strapi-webhook-actions-proxy:latest
3032
```
3133

32-
Create a new Webhook in strapi that points to the service with the following query params:
34+
4. Create a new Webhook in strapi that points to the service with the following query params:
3335

3436
- `event_type`: Any string. This value must match the `repository_dispatch` type specified in your GitHub Actions workflow file.
3537
- `repo`: GitHub `username/repo`

0 commit comments

Comments
 (0)