nodejs/hookshot
nodejs/hookshot
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-hookshot.git synced 2025-03-10 21:19:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
hookshot/3.0.1/usage/room_configuration.html

386 lines
34 KiB
HTML
Raw Permalink Normal View History

deploy: dd76b9dbcd58ba36fac1f4abfb5030904df1b1f5
2023-03-21 12:53:46 +00:00
<!DOCTYPE HTML>
<html lang="en" class="sidebar-visible no-js light">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>Room Configuration - Matrix Hookshot</title>
<!-- Custom HTML head -->
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff" />
<link rel="icon" href="../favicon.svg">
<link rel="shortcut icon" href="../favicon.png">
<link rel="stylesheet" href="../css/variables.css">
<link rel="stylesheet" href="../css/general.css">
<link rel="stylesheet" href="../css/chrome.css">
<link rel="stylesheet" href="../css/print.css" media="print">
<!-- Fonts -->
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="../fonts/fonts.css">
<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" href="../highlight.css">
<link rel="stylesheet" href="../tomorrow-night.css">
<link rel="stylesheet" href="../ayu-highlight.css">
<!-- Custom theme stylesheets -->
<link rel="stylesheet" href="../docs/_site/style.css">
</head>
<body>
<!-- Provide site root to javascript -->
<script type="text/javascript">
var path_to_root = "../";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
</script>
<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script type="text/javascript">
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>
<!-- Set the theme before any content is loaded, prevents flash -->
<script type="text/javascript">
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
</script>
<!-- Hide / unhide sidebar before it is displayed -->
<script type="text/javascript">
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
</script>
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<div class="sidebar-scrollbox">
<ol class="chapter"><li class="chapter-item expanded "><a href="../hookshot.html"><strong aria-hidden="true">1.</strong> ℹ️ Hookshot</a></li><li class="chapter-item expanded "><a href="../setup.html"><strong aria-hidden="true">2.</strong> ⚙️ Setup</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../setup/sample-configuration.html"><strong aria-hidden="true">2.1.</strong> 📃 Sample Configuration</a></li><li class="chapter-item expanded "><a href="../setup/feeds.html"><strong aria-hidden="true">2.2.</strong> Feed</a></li><li class="chapter-item expanded "><a href="../setup/figma.html"><strong aria-hidden="true">2.3.</strong> Figma</a></li><li class="chapter-item expanded "><a href="../setup/github.html"><strong aria-hidden="true">2.4.</strong> GitHub</a></li><li class="chapter-item expanded "><a href="../setup/gitlab.html"><strong aria-hidden="true">2.5.</strong> GitLab</a></li><li class="chapter-item expanded "><a href="../setup/jira.html"><strong aria-hidden="true">2.6.</strong> JIRA</a></li><li class="chapter-item expanded "><a href="../setup/webhooks.html"><strong aria-hidden="true">2.7.</strong> Webhooks</a></li></ol></li><li class="chapter-item expanded "><a href="../usage.html"><strong aria-hidden="true">3.</strong> 👤 Usage</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../usage/dynamic_rooms.html"><strong aria-hidden="true">3.1.</strong> Dynamic Rooms</a></li><li class="chapter-item expanded "><a href="../usage/auth.html"><strong aria-hidden="true">3.2.</strong> Authenticating</a></li><li class="chapter-item expanded "><a href="../usage/room_configuration.html" class="active"><strong aria-hidden="true">3.3.</strong> Room Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../usage/room_configuration/github_repo.html"><strong aria-hidden="true">3.3.1.</strong> GitHub Repo</a></li><li class="chapter-item expanded "><a href="../usage/room_configuration/gitlab_project.html"><strong aria-hidden="true">3.3.2.</strong> GitLab Project</a></li><li class="chapter-item expanded "><a href="../usage/room_configuration/jira_project.html"><strong aria-hidden="true">3.3.3.</strong> JIRA Project</a></li></ol></li></ol></li><li class="chapter-item expanded "><a href="../metrics.html"><strong aria-hidden="true">4.</strong> 📊 Metrics</a></li><li class="chapter-item expanded affix "><li class="part-title">🧑‍💻 Development</li><li class="chapter-item expanded "><a href="../contributing.html"><strong aria-hidden="true">5.</strong> Contributing</a></li><li class="chapter-item expanded affix "><li class="part-title">🥼 Advanced</li><li class="chapter-item expanded "><a href="../advanced/provisioning.html"><strong aria-hidden="true">6.</strong> Provisioning</a></li><li class="chapter-item expanded "><a href="../advanced/workers.html"><strong aria-hidden="true">7.</strong> Workers</a></li><li class="chapter-item expanded "><a href="../advanced/encryption.html"><strong aria-hidden="true">8.</strong> 🔒 Encryption</a></li><li class="chapter-item expanded "><a href="../advanced/widgets.html"><strong aria-hidden="true">9.</strong> 🪀 Widgets</a></li><li class="chapter-item expanded "><a href="../advanced/service_bots.html"><strong aria-hidden="true">10.</strong> Service Bots</a></li></ol> </div>
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
</nav>
<div id="page-wrapper" class="page-wrapper">
<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky bordered">
<div class="left-buttons">
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</button>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>
<h1 class="menu-title">Matrix Hookshot</h1>
<div class="right-buttons">
<a href="../print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>
<a href="https://github.com/matrix-org/matrix-hookshot" title="Git repository" aria-label="Git repository">
<i id="git-repository-button" class="fa fa-github"></i>
</a>
<a href="https://github.com/matrix-org/matrix-hookshot/edit/main/docs/usage/room_configuration.md" title="Suggest an edit" aria-label="Suggest an edit">
<i id="git-edit-button" class="fa fa-edit"></i>
</a>
</div>
</div>
<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script type="text/javascript">
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>
<div id="content" class="content">
<main>
<h1 id="room-configuration"><a class="header" href="#room-configuration">Room Configuration</a></h1>
<p>Hookshot works off the principle of <strong>Connections</strong>.</p>
<p>A room can have many connections to different services. The connections are defined
in the room state of a room. A connection defines the service it connects to, the
type of integration (e.g. GitHub repo, Jira Project) and any additional configuration.</p>
<figure>
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
width="128.84227mm"
height="60.402607mm"
viewBox="0 0 128.84227 60.402607"
version="1.1"
id="svg8"
style="background-color: white"
inkscape:version="0.92.5 (2060ec1f9f, 2020-04-08)"
sodipodi:docname="connections1.svg">
<defs
id="defs2" />
<sodipodi:namedview
id="base"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageopacity="0.0"
inkscape:pageshadow="2"
inkscape:zoom="1.256313"
inkscape:cx="244.71246"
inkscape:cy="81.676622"
inkscape:document-units="mm"
inkscape:current-layer="layer1"
showgrid="false"
inkscape:window-width="2560"
inkscape:window-height="1376"
inkscape:window-x="0"
inkscape:window-y="27"
inkscape:window-maximized="1"
inkscape:lockguides="true"
fit-margin-top="0"
fit-margin-left="0"
fit-margin-right="0"
fit-margin-bottom="0" />
<metadata
id="metadata5">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
</cc:Work>
</rdf:RDF>
</metadata>
<g
inkscape:label="Layer 1"
inkscape:groupmode="layer"
id="layer1"
transform="translate(-10.574726,-45.0311)">
<rect
style="fill:none;fill-opacity:1;stroke:#000000;stroke-width:0.60000002;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
id="rect10"
width="39.555889"
height="33.94323"
x="99.156998"
y="58.595577" />
<text
xml:space="preserve"
style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.60000002;stroke-miterlimit:4;stroke-dasharray:none"
x="103.42371"
y="77.304451"
id="text819"><tspan
sodipodi:role="line"
id="tspan817"
x="103.42371"
y="77.304451"
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:5.64444447px;font-family:Arial;-inkscape-font-specification:Arial;text-align:start;text-anchor:start;stroke-width:0.60000002;stroke-miterlimit:4;stroke-dasharray:none">Matrix Room</tspan></text>
<g
style="stroke-width:0.60000002;stroke-miterlimit:4;stroke-dasharray:none"
transform="translate(21.130306,42.327584)"
id="g879">
<ellipse
style="fill:#ff9955;fill-opacity:1;stroke:#000000;stroke-width:0.57284814;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
id="path874"
cx="46.504902"
cy="17.1688"
rx="14.847034"
ry="14.178861" />
<text
id="text819-3"
y="18.876226"
x="46.575386"
style="font-style:normal;font-weight:normal;font-size:7.71111298px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.4371655;stroke-miterlimit:4;stroke-dasharray:none"
xml:space="preserve"><tspan
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.11259365px;font-family:Arial;-inkscape-font-specification:Arial;text-align:center;text-anchor:middle;stroke-width:0.4371655;stroke-miterlimit:4;stroke-dasharray:none"
y="18.876226"
x="46.575386"
id="tspan817-1"
sodipodi:role="line">Connection</tspan></text>
</g>
<ellipse
ry="14.178861"
rx="14.847034"
cy="89.717857"
cx="67.657738"
id="path874-3"
style="fill:#ffe680;fill-opacity:1;stroke:#000000;stroke-width:0.57284814;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
<text
xml:space="preserve"
style="font-style:normal;font-weight:normal;font-size:7.71111298px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.4371655;stroke-miterlimit:4;stroke-dasharray:none"
x="67.539238"
y="91.425285"
id="text819-3-4"><tspan
sodipodi:role="line"
id="tspan817-1-0"
x="67.539238"
y="91.425285"
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.11259365px;font-family:Arial;-inkscape-font-specification:Arial;text-align:center;text-anchor:middle;stroke-width:0.4371655;stroke-miterlimit:4;stroke-dasharray:none">Connection</tspan></text>
<path
style="fill:none;stroke:#000000;stroke-width:0.65899998;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="M 99.218749,89.528869 H 82.500017"
id="path984"
inkscape:connector-curvature="0" />
<path
inkscape:connector-curvature="0"
id="path1035"
style="fill:#1b1817;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.05966344"
d="m 25.950026,48.489111 c -5.366124,0 -9.71799,4.351256 -9.71799,9.719176 0,4.293381 2.784503,7.93643 6.646516,9.222177 0.486251,0.08889 0.66346,-0.211208 0.66346,-0.468954 0,-0.230897 -0.0085,-0.841852 -0.01353,-1.652678 -2.703357,0.587089 -3.27373,-1.303048 -3.27373,-1.303048 -0.442109,-1.122867 -1.07932,-1.421781 -1.07932,-1.421781 -0.882425,-0.6026 0.0668,-0.590668 0.0668,-0.590668 0.975494,0.06861 1.488602,1.001749 1.488602,1.001749 0.866916,1.485023 2.274964,1.056044 2.828644,0.807246 0.08828,-0.627659 0.339484,-1.056042 0.616916,-1.298873 -2.158014,-0.245812 -4.427025,-1.079311 -4.427025,-4.803503 0,-1.061413 0.378873,-1.928323 1.000559,-2.60789 -0.100291,-0.245812 -0.433754,-1.233839 0.09556,-2.572091 0,0 0.815587,-0.261324 2.672323,0.995783 0.775031,-0.215384 1.606735,-0.322778 2.433079,-0.326955 0.825734,0.0042 1.656847,0.111571 2.433062,0.326955 1.855534,-1.257107 2.669937,-0.995783 2.669937,-0.995783 0.530409,1.338252 0.196895,2.326279 0.09725,2.572091 0.622886,0.679567 0.998766,1.546477 0.998766,2.60789 0,3.733739 -2.272579,4.555304 -4.437173,4.795747 0.348431,0.300107 0.659282,0.893161 0.659282,1.800047 0,1.298873 -0.01184,2.34716 -0.01184,2.665762 0,0.260133 0.175416,0.562626 0.668228,0.467762 3.859037,-1.288135 6.641138,-4.928201 6.641138,-9.220985 0,-5.36792 -4.351849,-9.719176 -9.719766,-9.719176" />
<path
inkscape:connector-curvature="0"
id="path1125"
style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:0.03527778"
d="m 133.67005,94.224236 c -3.17288,0 -5.74605,2.572808 -5.74605,5.74675 0,2.538944 1.64642,4.692654 3.92995,5.452534 0.28751,0.0529 0.39229,-0.12453 0.39229,-0.27693 0,-0.13653 -0.005,-0.49777 -0.008,-0.9772 -1.59844,0.34714 -1.93569,-0.77046 -1.93569,-0.77046 -0.26141,-0.66393 -0.63818,-0.84067 -0.63818,-0.84067 -0.52176,-0.35631 0.0395,-0.34925 0.0395,-0.34925 0.57679,0.0406 0.88018,0.59231 0.88018,0.59231 0.51259,0.87807 1.34514,0.62442 1.67252,0.47731 0.0522,-0.37112 0.20073,-0.62442 0.36477,-0.768 -1.27599,-0.14499 -2.61761,-0.63817 -2.61761,-2.840211 0,-0.627239 0.22402,-1.14053 0.59161,-1.541991 -0.0593,-0.145345 -0.25647,-0.729898 0.0565,-1.520825 0,0 0.48224,-0.154517 1.58009,0.589138 0.45826,-0.127705 0.95003,-0.191205 1.43863,-0.193675 0.48824,0.0025 0.97966,0.06597 1.43862,0.193675 1.09714,-0.743655 1.57868,-0.589138 1.57868,-0.589138 0.31362,0.790927 0.11642,1.37548 0.0575,1.520825 0.3683,0.401461 0.59055,0.914752 0.59055,1.541991 0,2.207681 -1.34373,2.693461 -2.62361,2.835631 0.20602,0.17744 0.38982,0.52811 0.38982,1.06398 0,0.76835 -0.007,1.38818 -0.007,1.57656 0,0.15381 0.10372,0.33267 0.39511,0.27658 2.28177,-0.76165 3.92677,-2.91395 3.92677,-5.452184 0,-3.173942 -2.57316,-5.74675 -5.7471,-5.74675" />
<text
xml:space="preserve"
style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000080;fill-opacity:1;stroke:none;stroke-width:0.26458332"
x="99.974701"
y="85.711311"
id="text1495"><tspan
sodipodi:role="line"
id="tspan1493"
x="99.974701"
y="85.711311"
style="font-size:4.23333311px;fill:#000080;stroke-width:0.26458332">!foo:example.com</tspan></text>
<path
style="fill:none;stroke:#000000;stroke-width:0.65899998;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="M 99.073652,61.369644 H 82.35492"
id="path984-6"
inkscape:connector-curvature="0" />
<path
style="fill:none;stroke:#000000;stroke-width:0.65899998;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="M 52.393597,58.308035 H 35.67486"
id="path984-6-4"
inkscape:connector-curvature="0" />
<path
style="fill:#000000;stroke-width:0.00630857"
d="m 20.801015,96.539047 c -0.0641,-0.0202 -0.11794,-0.0634 -0.13856,-0.11136 -0.0107,-0.0249 -0.34026,-1.09412 -0.34837,-1.13028 -0.005,-0.0215 -0.005,-0.0412 -4.2e-4,-0.0658 0.0185,-0.0999 0.0965,-0.17205 0.19575,-0.18107 0.13953,-0.0127 0.25122,-0.0365 0.35796,-0.0764 0.33057,-0.12348 0.55312,-0.36647 0.63794,-0.69654 0.0417,-0.1623 0.0387,0.11098 0.0387,-3.51276 0,-2.04527 0.002,-3.29842 0.006,-3.32121 0.012,-0.073 0.0547,-0.12801 0.1253,-0.16111 l 0.0358,-0.0168 0.70656,-0.002 c 0.51217,-0.001 0.71817,-2e-5 0.74878,0.005 0.0423,0.007 0.1045,0.0384 0.12301,0.0616 0.0207,0.0259 0.0379,0.0569 0.0449,0.081 0.01,0.0341 0.0109,6.80258 0.001,6.91977 -0.0389,0.46192 -0.18919,0.87846 -0.44419,1.2312 -0.35938,0.49711 -0.90361,0.84076 -1.50647,0.95127 -0.15638,0.0287 -0.23031,0.035 -0.39889,0.0344 -0.11333,-4.5e-4 -0.16554,-0.003 -0.18494,-0.009 z m 4.09921,-0.57229 c -0.0628,-0.019 -0.12974,-0.0889 -0.14636,-0.15291 -0.007,-0.0257 -0.008,-0.80152 -0.008,-4.20151 v -4.16996 l 0.0152,-0.0377 c 0.0203,-0.0505 0.0655,-0.0975 0.11589,-0.12082 l 0.0393,-0.0181 h 0.72548 0.72549 l 0.0378,0.0177 c 0.0493,0.023 0.0924,0.0659 0.11466,0.11413 l 0.0178,0.0385 v 4.18258 4.18258 l -0.0148,0.0368 c -0.008,0.0202 -0.0238,0.047 -0.0347,0.0594 -0.0244,0.0279 -0.0742,0.0598 -0.10891,0.0698 -0.0347,0.01 -1.44537,0.01 -1.47862,-4.6e-4 z m 3.24891,-7e-4 c -0.0191,-0.004 -0.0446,-0.0129 -0.0568,-0.0192 -0.0346,-0.0178 -0.075,-0.0604 -0.0935,-0.0983 l -0.0169,-0.0347 -0.002,-4.17943 c -0.001,-3.17286 -1.4e-4,-4.18714 0.005,-4.21148 0.0151,-0.0655 0.0829,-0.13534 0.14831,-0.15284 0.0362,-0.01 3.56726,-0.0108 3.75625,-10e-4 0.95427,0.0486 1.59816,0.2968 1.99612,0.76957 0.25732,0.30569 0.40804,0.70209 0.46084,1.21195 0.019,0.18345 0.0234,0.41756 0.0205,1.08437 -0.003,0.68067 -0.005,0.73295 -0.0332,0.92567 -0.0537,0.36502 -0.15981,0.65827 -0.3355,0.9274 -0.17444,0.26722 -0.45721,0.50435 -0.77768,0.65216 -0.0447,0.0206 -0.0786,0.0399 -0.0782,0.0446 10e-4,0.0168 1.46822,2.12576 1.47277,2.11734 0.005,-0.008 0.0167,-0.0468 0.21639,-0.68019 0.0607,-0.19257 0.31376,-0.99454 0.56236,-1.78217 0.24861,-0.78762 0.54419,-1.72445 0.65686,-2.08183 0.11267,-0.35738 0.21303,-0.67533 0.22303,-0.70656 0.01,-0.0312 0.17886,-0.56635 0.37527,-1.18916 0.19641,-0.62281 0.36328,-1.148 0.37083,-1.16708 0.0186,-0.047 0.059,-0.0888 0.1074,-0.11117 l 0.0393,-0.0182 h 1.08191 c 1.0268,0 1.08333,5.7e-4 1.10961,0.0113 0.0449,0.0184 0.0818,0.0473 0.10468,0.0822 0.0176,0.0267 0.0832,0.22847 0.36271,1.11456 0.18768,0.59506 0.34382,1.08902 0.34696,1.09769 0.003,0.009 0.442,1.398 0.97524,3.08738 0.96731,3.06462 0.96951,3.07171 0.96644,3.11462 -0.006,0.0813 -0.0582,0.1521 -0.136,0.18351 l -0.036,0.0145 h -0.76018 -0.76019 l -0.0352,-0.0143 c -0.0408,-0.0165 -0.0825,-0.0501 -0.10357,-0.0835 -0.008,-0.0134 -0.1214,-0.36772 -0.26465,-0.83023 -0.13745,-0.44378 -0.25258,-0.81322 -0.25584,-0.82098 l -0.006,-0.0141 -0.98918,-0.002 -0.98918,-0.002 -0.042,-0.0207 c -0.0453,-0.0223 -0.0897,-0.0656 -0.10944,-0.10681 -0.007,-0.0154 -0.0123,-0.043 -0.0139,-0.0775 l -0.002,-0.0536 0.16167,-0.58039 c 0.0889,-0.31921 0.16813,-0.59458 0.17603,-0.61193 0.0176,-0.0386 0.0646,-0.086 0.1032,-0.10418 0.0158,-0.007 0.0446,-0.0161 0.064,-0.0193 0.0195,-0.003 0.28981,-0.006 0.60508,-0.006 0.5397,-7e-5 0.56959,-5.7e-4 0.56641,-0.0111 -0.002,-0.006 -0.18947,-0.65404 -0.41695,-1.43993 -0.22747,-0.78589 -0.41962,-1.44403 -0.42699,-1.46254 -0.0181,-0.0455 -0.0659,-0.0966 -0.10759,-0.11505 -0.051,-0.0226 -0.12786,-0.0215 -0.1767,0.002 -0.0457,0.0224 -0.0878,0.0643 -0.10767,0.10689 -0.0114,0.0244 -0.9754,3.28073 -1.29472,4.37333 -0.28373,0.97086 -0.52273,1.76749 -0.53709,1.79023 -0.0233,0.0369 -0.0531,0.0644 -0.092,0.0849 l -0.0331,0.0174 -1.42574,0.002 c -1.05248,0.001 -1.43685,7e-5 -1.46819,-0.005 -0.03,-0.005 -0.0531,-0.0142 -0.0788,-0.0308 -0.0434,-0.0281 -0.0551,-0.0416 -0.13015,-0.15038 -0.0317,-0.046 -0.4551,-0.65552 -0.94086,-1.3546 l -0.8832,-1.27105 -0.69867,-1.4e-4 -0.69868,-1.4e-4 v 1.30454 c 0,1.42237 0.002,1.34374 -0.0352,1.40259 -0.0248,0.0393 -0.051,0.062 -0.0968,0.0837 l -0.0415,0.0197 -0.70656,
id="path1560"
inkscape:connector-curvature="0" />
<path
style="fill:none;stroke:#000000;stroke-width:0.53958774;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="M 52.393597,91.116389 H 41.184857"
id="path984-6-4-0"
inkscape:connector-curvature="0" />
</g>
</svg>
<figcaption>Figure 1. An example of a room connected to GitHub and JIRA</figcaption>
</figure>
<p>Hookshot supports several connection types, which are defined under the Room Configuration
heading.</p>
<p>The availability of connection types depends on the configuration provided to hookshot.</p>
<h3 id="the-hookshot-command"><a class="header" href="#the-hookshot-command">The <code>!hookshot</code> command</a></h3>
<p>Rooms can be bridged by inviting the hookshot bot into a room, and then running the
<code>!hookshot</code> command. Running <code>!hookshot help</code> will give you some details, but you should
see the documentation provided for information on each connection type.</p>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="../usage/auth.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next" href="../usage/room_configuration/github_repo.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
<div style="clear: both"></div>
</nav>
</div>
</div>
<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="../usage/auth.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next" href="../usage/room_configuration/github_repo.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>
</div>
<script type="text/javascript">
window.playground_copyable = true;
</script>
<script src="../elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
<script src="../mark.min.js" type="text/javascript" charset="utf-8"></script>
<script src="../searcher.js" type="text/javascript" charset="utf-8"></script>
<script src="../clipboard.min.js" type="text/javascript" charset="utf-8"></script>
<script src="../highlight.js" type="text/javascript" charset="utf-8"></script>
<script src="../book.js" type="text/javascript" charset="utf-8"></script>
<!-- Custom JS scripts -->
<script type="text/javascript" src="../docs/_site/main.js"></script>
<script type="text/javascript" src="../docs/_site/version.js"></script>
</body>
</html>
Reference in New Issue Copy Permalink