GitHub Events

The built-in GitHub Events trigger initiates a flow when it receives a signal from a GitHub Events webhook.

Add the GitHub Events trigger to the canvas

  1. Go to the Triggers panel in the palette, expand the App Triggers section and drag the trigger onto the canvas.
  2. Double-click the trigger (or click the pencil icon).
  3. Set the authenticating user, and then copy the URL — you'll use this to set up the webhook in GitHub Events. Alternatively, you can create an integration user to use as the authenticating user.

  4. Click the Flood Control tab to edit the trigger's default flood control settings. For more information about these settings, see Trigger Flood Control.
  5. Click Done.
  6. On the flow canvas, connect the steps you want to run when xMatters receives a request to that URL.

You're now ready to configure GitHub Events to target the trigger.

Configure GitLab to send requests to the trigger URL

To have GitLab send alerts to the flow trigger, you need to configure a webhook and set it to use the trigger URL.

  1. In GitLab, go to Settings > Webhooks.

  2. On the Webhooks page fill in the following fields: 
    • Url: Paste the trigger URL you copied from Flow Designer.
    • Add the target names of any recipients you want xMatters to notify when the alert fires.
      • For example, if you want to notify Emma Pearson, Mary McBride, and the on-call members in the Monitor Team responsible for the service, you'd add ?recipients=epearson,mmcbride,monitor%20team to the URL.
      • You must URL-encode any special characters or spaces in the target names.
    • Select the type of GitLab events that will send changes to xMatters. The following event types are supported: 
      • Push events
      • Merge request events
      • Job events
      • Pipeline events
      • Deployment events
      • Feature flag events
      • Releases events
    • Leave Enable SSL verification selected.

  3. Click Add webhook.

You're ready to use the webhook to trigger automated flows, including steps such as sending alerts and initiating incidents, though we always recommend testing before putting things into use.

Outputs

The trigger has the following outputs you can use as inputs to steps further along the flow.

Label

 Description

Recipients

 List of targeted recipients. Recipients are set by adding a recipients query parameter to the trigger URL.
Action GitHub activity that triggered the webhook event.
Change Type Type of GitHub change to record in xMatters.
Description Detailed description of the change.
Public ID Public ID of the webhook event.
Reference Location Location where the webhook event occurred.
Repository Link Direct link to the GitHub repository where the webhook event occurred.
Repository Name Name of the GitHub repository where the webhook event occurred.
Sender Name of the GitHub user that triggered the webhook event.
Summary Summary of the webhook event provided by GitHub.
Timestamp Timestamp of when the webhook event occurred.
Webhook Event Type

Type of GitHub webhook event. Supported values are:

  • push
  • pull_request
  • release
  • deployment
  • workflow_job
  • workflow_run
Raw Request JSON representation of the request. You can parse the raw request if you need additional details beyond the standard outputs.