Webhook with Github

Configuring the Webhook

1. Under Method Type, select Post.
2. Enter the GitHub account URL in the URL field.
3. Select Basic Auth, then enter the GitHub account username and password in the Username and Password fields.
4. Optional parameters and custom header names and values can also be configured.
5. Under Post Payload, enter the payload code, for example:

This automation uses the Execute Webhook action to post idea data — including the submitter's email address, the idea title, description, and URL — to a GitHub account each time an idea satisfies the rule's condition. Automation rules are configured by a Community Administrator.

Role Permissions

1. Community Administrator: Can create, configure, test, and enable an automation rule that pushes idea data to GitHub via webhook.

Creating the Automation Rule

1. Select Create to begin building a new automation rule.
   
   
2. Enter a name for the rule in the Rule Name field.
3. Under Condition, use the drop-down menus to build a condition based on Idea, then select the activity that should trigger the idea being pushed to the GitHub account. Note: In the example configuration, the condition is set to trigger when an idea moves to the ReviewScale stage.
4. Under Action, select Execute Webhook in the Name field, then select Save. Saving displays additional configuration options.

Configuring the Webhook

1. Under Method Type, select Post.
2. Enter the GitHub account URL in the URL field.
3. Select Basic Auth, then enter the GitHub account username and password in the Username and Password fields.
4. Optional parameters and custom header names and values can also be configured.
5. Under Post Payload, enter the payload code, for example:
   {
     "name": "{emailAddress}",
     "title": "{ideaTitle}",
     "desc": "{ideaDesc}",
     "urlSource": "{ideaUrl}",
     "pos": "top"
   }

Testing and Enabling the Automation Rule

1. Select Test Webhook to confirm the configuration. A successful test produces a new request in the GitHub account.
2. Select Enable, then select Save to activate the automation rule. Once enabled, any idea that satisfies the rule's condition is pushed to the GitHub account automatically.

Frequently Asked Questions

What triggers the webhook to send data to GitHub?

The webhook runs whenever an idea meets the condition configured under Condition in the automation rule, such as reaching a specific stage.

What authentication method connects the automation rule to GitHub?

The rule connects using Basic Auth, with a GitHub account username and password entered in the Username and Password fields.

What idea data is included in the payload sent to GitHub?

The Post Payload can include the submitter's email address, the idea title, the idea description, and the idea URL.

Related Articles

• Help Article for Automation Builder