GitHub¶
Github allows for the creation of webhook triggers at the organization, repository or app level. Further details regarding the specifics of what GitHub makes available is detailed in their Webhook Documentation
To create a GitHub webhook to send events to Observe you will need:
A GitHub account and organistation or repository
An Observe ingest token
Setting up the webhook¶
For a repo or organization, go to settings
Click Webhooks and then Add
Payload URL is to our collector using basic auth, replace
CUSTOMER_ID
andTOKEN
with your Customer ID and Ingest Token respectivly the/github
at the end allows observe to identify this data as coming from GitHub:https://CUSTOMER_ID:[email protected]/v1/http/github
Set the Content Type to
application/json
Leave Secret blank, this value is not used by Observe
Enable SSL verification
Decide what events you want, it is okay to pick everything, these events can be modeled in Observe post ingestion
Make sure active is checked.
Click Add Webhook
Verify GitHub data is being ingested¶
There are two places to validata, the first is to check GitHub has successfully send the data, and second is to check data is being recieved in Observe.
To check that GitHub is sending the data:
For a repo or organization, go to Settings
Click Webhooks
Click the entry for the webhook created above
Scroll to Recent Deliveries and check the recent calls recived a
202
response code
To check in Observe:
Log into Observe and open the Observation event stream in a worksheet
Open the OPAL console and apply the following filters:
filter OBSERVATION_KIND = "http" filter (string(EXTRA.path) = "/github")
Verify GitHub exists