Assembla's Webhooks tool allows you to post information about space activities such as code commits, Tickets tool activities, posted files, etc. to external systems. (i.e., Slack channels).
Note: Not all plans allow for access to the Webhooks Tool. If you would like to upgrade to the Enterprise Cloud plan to gain access to Webhooks please contact us at sales@assembla.com and check our Pricing Page to see what features are included with your plan.
Installing the Webhooks tool
To install the Webhooks tool
Go to Space Settings > Tools.
Scroll down to Webhook, and then click Add.
Configuring the tool
To configure the Webhooks tool
Go to Space Settings.
In the Tools section, click Settings next to Webhook. The Webhooks page appears. Note: You can select from preconfigured webhooks in the panel to the left or start from scratch and configure your own. If you would like us to add your company to the list of preconfigured webhooks, please email us at support@assembla.com.
Click Create New Webhook.
Complete the following fields:
Enabled/Disabled. Use this toggle to turns on/off the webhook. When your webhook is configured, and you are ready to post info, make sure to enable it.
Title. Name of the webhook that appears in the submenu.
Authentication type. Choose one of the following authentication methods:
Basic. Give the webhook the username and password required by the external system through the external url. http://your_username:your_password@link_to_the_external_system_API In some pre-configured posts, you just need to replace your_username and your_password in the URL with your information.
OAuth. Lets you use apps without them storing your password. Give the webhook your app's API key and secret. Set up the external service OAuth URL, typically provided provided in external service's API documentation. Authenticate with the service and you are done.
HTTP method. Select POST or GET. POST is most commonly used to post info to the external systems. If you select GET, the Content type and Content fields are disabled.
Content Type. POST only. If you select POST as the HTTP method, you can select the desired content type from a list of the following options:
application/xml
application/json
application/x-www-form-urlencoded
text/html
text/plain
Content. POST only. If you select POST as the HTTP method, you can configure the desired format to display posted information. The following variables are available:
%{author}. Name of the author who triggered the event.
%{object}. Class name of the related object in the event.
%{space}. Project in which the event happened.
%{action}. Action that triggered the event.
%{title}. Title of a message, wiki page, or name of uploaded file.
%{body}. Content of a message or wiki page.
%{link}. Link to the event in Assembla.
%{repository_url}. URL for the repository that received the commit.
%{repository_suffix}. Suffix for the repository that received the commit. If repository suffix is blank, 'origin' is returned.
%{branch}. Branch to which the commit was made. This option is available only for commit events and only for Git.
%{commit_id}. Commit ID. This option is available only for repository commit events.
For example, when a message event occurs:
%{author} %{action} a %{object}: "%{title}" in project %{space}
generates:
Andy created a message: "we need to discuss the new design tomorrow" in project Assembla DevelopmentPost updates about. Check each box for the desired project events.
Note: If you subscribe to Code Commits and Git Push, it generates one push event and one or more commit events because multiple commits can push at once.
Click Add.
If you have any questions or need assistance. Please always feel free to email us at support@assembla.com. We will be happy to assist.