GitHub

Send GitHub change events to Cardinal.

Generate a Cardinal API Key

1. Navigate to the API Keys page (opens in a new tab) in the Cardinal UI.
2. Click the Create API Key button, and give it a descriptive name.
3. Copy the API Key to use below.

Add Webhook to GitHub

1. Navigate to your Organization or Repository settings in GitHub.
2. Click the Webhooks tab in the left sidebar.
3. Click the Add webhook button.
4. Set the Payload URL to https://api.global.aws.cardinalhq.io/api/v1/webhooks/github?x-cardinalhq-api-key=YOUR_CARDINAL_API_KEY.
5. Set the Content type to application/json.
6. Select Let me select individual events and select the event types you'd like to send to Cardinal. We recommend selecting the following event types:
   • Pushes
   • Pull requests
   • Workflow jobs
   • Workflow runs
   
   
7. Click the Add webhook button.