Add open registration to Synapse homeserver config in CI
[gitter.git] / docs / integrations.md
blob53bebca5ae30687890330963c911ac2805b7fddf
1 # Integrations/Activity
3 Gitter is integrated with numerous services via webhooks. When you add an integration to a chat room, you will see events from that integration appear in the right-toolbar under the "Activity" section.
5 ![](https://i.imgur.com/nZZcCN3.png)
7 Our integrations include:
9  - GitLab
10  - GitHub
11  - BitBucket
12  - Trello
13  - AppVeyor
14  - CircleCI
15  - Codecov
16  - Codeship
17  - Coveralls
18  - Discourse
19  - Docker Hub
20  - Doorbell
21  - Drone
22  - GitBook
23  - GoCD
24  - Heroku
25  - Huboard
26  - Jenkins
27  - Logentries
28  - New Relic
29  - Open Collective
30  - PagerDuty
31  - Pivotal Tracker
32  - Sentry
33  - SnapCI
34  - Sprint.ly
35  - The Bug Genie
36  - TrackJS
37  - Travis
38  - Send us a Merge request to add your own, https://gitlab.com/gitlab-org/gitter/services
41 ## Setup
43 **Room settings dropdown** -> **Integrations**
45 ![](https://i.imgur.com/AI4pBBP.png)
47 ### GitHub
49 #### Per-repository
51 Integrations for a set of GitHub repositories can be configured
52 automatically by using the **Integrations** menu shown above:
54 1. **Room settings dropdown** -> **Integrations**
55 2. Select **GitHub**
56 3. Authorise the use of the app, if necessary
57 4. Select one or more repositories from the displayed list
59 Events occurring in the selected repositories will now be displayed
60 in the room as notifications.
62 #### Per-organisation
64 It may be desirable to automatically receive all notifications for
65 all repositories in a given GitHub organisation.  If your GitHub
66 organisation frequently adds repositories, and you have a single Gitter
67 room for the entire organisation, it can be rather laborious to
68 continually add new integrations for each new repository.  Currently,
69 receiving notifications for an entire organisation requires manual
70 configuration.
72 To set up notifications for an entire organisation:
74 1. **Room settings dropdown** -> **Integrations** -> **GitHub** -> **Configure manually**
75 2. A dialog box will appear containing an access token. For the sake
76    of these instructions, we will assume that the access token is `e07c5162bd8b`.
78 Now, go to your organisation on GitHub and navigate to the organisation's
79 settings, and go to the **Webhooks** section. Add a new webhook, and enter
80 the following settings:
82 | Field        | Value                                     |
83 |--------------|-------------------------------------------|
84 | Payload URL  |`https://webhooks.gitter.im/e/e07c5162bd8b`|
85 | Content-type | application/json                          |
86 | Secret       |                                           |
88 Note that `e07c5162bd8b` should obviously be replaced with the access token
89 generated for you in step `2` above.
91 Confirm the addition of the webhook, and you should now start receiving
92 organisation-wide events in the configured Gitter room.