Configure a Webhook in GitHub

A. Create a Webhook API Token from ARM

Follow the steps below to create a webhook API token in ARM:

1. Log in to ARM.

2. Navigate to the Admin section and select API Token.

3. Click Create API Token.

1. Enter a Token Name.

2. Select Type as webhook.

3. (Optional) Add a Description.

4. Click Create Option.

1. Your API token is now created.

B. Create Webhook with Authentication on GitHub

Webhooks allow external services to receive notifications about repository events. GitHub sends a POST request to the configured URL when those events occur.

Steps to Configure:

1. Go to https://github.com/login and log in.

2. Open your target repository.

1. Click Settings in the right panel.

1. In the left menu, click Webhooks & Services, then Add Webhook.

1. In the Payload URL, enter the webhook endpoint:

1. Enter the Secret Key from ARM’s API token.

1. Set Content Type to application/json.

1. Choose Just the push events.

2. Click Add Webhook.

1. To trigger webhooks for pull requests, select Let me select individual events and check Pull requests.

1. Click Add webhook to finalize.

Smart Commits

Smart Commits allow linking commits to ALM stories using custom comment patterns. For example:

To configure a webhook in your repository:

• Enable the Enable auto update on webhook checkbox to reveal the webhook URL.

• For more repository-specific instructions, refer to the Webhook Configuration Guide.

• You may also choose to Sync External Smart Commits.

For Enterprise Customers

Use the following endpoints for enterprise-specific integrations: /api/webhook/v2//enterprise/trigger-scm-push-request /api/webhook/v2//enterprise/sync-alm-commits