Skip to content

Commit

Permalink
Merge pull request #528 from TheZalRevolt/master
Browse files Browse the repository at this point in the history
Docs - added mention to the fact that github webhook should be in json format
  • Loading branch information
roekatz authored Apr 30, 2024
2 parents 694a599 + edf629b commit f29b44f
Showing 1 changed file with 2 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ It is much more recommended to use webhooks if your policy repo is stored in a s

If your server is hosted at `https://opal.yourdomain.com` the webhook URL you must setup with your webhook provider (e.g: github) is `https://opal.yourdomain.com/webhook`. See [GitHub's guide on configuring webhooks](https://docs.github.com/en/developers/webhooks-and-events/creating-webhooks).

Keep in mind that the webhook should be in `JSON` format.

Typically you would need to share a secret with your webhook provider (authenticating incoming webhooks). You can use the OPAL CLI to create a cryptographically strong secret to use.

<a name="generate-secret"></a>Let's install the cli to a new python virtualenv:{" "}
Expand Down

0 comments on commit f29b44f

Please sign in to comment.