Skip to content
This repository was archived by the owner on Nov 1, 2017. It is now read-only.

Commit cb872ee

Browse files
committed
Continue changing references to web hooks
1 parent a5f09d7 commit cb872ee

6 files changed

Lines changed: 19 additions & 21 deletions

File tree

content/v3/repos/deployments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ the `description` would be the high level summary of what happened with the
3737
deployment.
3838

3939
Deployments and Deployment Statuses both have associated repository events when
40-
they're created. This allows web hooks and 3rd party integrations to respond to
40+
they're created. This allows webhooks and 3rd party integrations to respond to
4141
deployment requests as well as update the status of a deployment as progress is
4242
made.
4343

content/webhooks/creating/index.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,24 @@ information about activity in a repository. Webhooks can trigger across several
1313
different actions. For example, you can fire a payload of information any time
1414
a commit is made, a repository is forked, or an issue is created.
1515

16-
In this tutorial, our hook will be responsible for listing out how popular our
16+
In this tutorial, our webhook will be responsible for listing out how popular our
1717
repository is, based on the number of Issues it receives per day.
1818

19-
Creating a hook is a two-step process. You'll first need to set up how you want
20-
your hook to behave through GitHub--what events should it listen to, and what
21-
fields (if any) should be passed along. After that, you'll manage how to receive
22-
the payload on your server.
19+
Creating a webhook is a two-step process. You'll first need to set up how you want
20+
your webhook to behave through GitHub--what events should it listen to. After that,
21+
you'll set up your server to receive and manage the payload.
2322

2423
## Setting up a Hook
2524

26-
To set up a hook on GitHub, head over to the **Settings** page of your repository,
25+
To set up a webhook on GitHub, head over to the **Settings** page of your repository,
2726
and click on **Webhooks & services**. After that, click on **Add webhook**.
2827

2928
You'll be presented with a page that lists all the capabilities your webhook
3029
can take advantage of. We'll go through each of these below.
3130

3231
## Payload URL
3332

34-
This is the server endpoint that will receive the hook payload.
33+
This is the server endpoint that will receive the webhook payload.
3534

3635
Since we're developing locally for our tutorial, let's set it to `http://localhost:4567/payload`.
3736
We'll explain why in the [Configuring Your Server](/hooks/configuring/) docs.
@@ -43,15 +42,15 @@ Choose the one that best fits your needs. For this tutorial, the default format
4342

4443
## Events
4544

46-
Events are at the core of webhooks. These hooks fire whenever a certain action is
45+
Events are at the core of webhooks. These webhooks fire whenever a certain action is
4746
taken on the repository, which your server's payload URL intercepts and acts upon.
4847

49-
A full list of hooks, and when they execute, can be found in [the hooks API][hooks-api] reference.
48+
A full list of webhook events, and when they execute, can be found in [the webhooks API][hooks-api] reference.
5049

51-
Since our hook is dealing with Issues in a repository, we'll click on **Issues**,
50+
Since our webhook is dealing with Issues in a repository, we'll click on **Issues**,
5251
and toggle the options there.
5352

54-
When you're finished, click on **Add webhook**. Phew! Now that the hook is created,
53+
When you're finished, click on **Add webhook**. Phew! Now that the webhook is created,
5554
it's time to set up our local server to test the webhook. Head on over to
5655
[Configuring Your Server](/hooks/configuring/) to learn how to do that.
5756

layouts/guides.html

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
<body class="api">
44
<%= render 'header' %>
5-
5+
66
<div class="sub-nav">
77
<h2><a href="/v3/">API</a></h2>
8-
8+
99
<ul>
1010
<li><a href="/v3/">Documentation</a></li>
1111
<li><a href="/guides/" class="active">Guides</a></li>
1212
<li><a href="/libraries/">Libraries</a></li>
1313
</ul>
1414
</div>
15-
15+
1616
<div id="wrapper">
1717
<div class="content">
1818
<%= yield %>
@@ -27,17 +27,16 @@ <h2><a href="/v3/">API</a></h2>
2727
<li><h3><a href="/guides/rendering-data-as-graphs/">Rendering Data as Graphs</a></h3></li>
2828
<li><h3><a href="/guides/working-with-comments/">Working with Comments</a></h3></li>
2929
<li><h3><a href="/guides/traversing-with-pagination/">Traversing with Pagination</a></h3></li>
30-
<li><h3><a href="/guides/developing-hooks/">Developing Hooks</a></h3></li>
3130
</ul>
3231
</div>
33-
32+
3433
<div class="sidebar-module notice">
3534
<p>This website is a <a href="https://github.com/github/developer.github.com" target="_blank">public GitHub repository</a>. Please help us by forking the project and adding to it.</p>
3635
</div>
3736
<div class="sidebar-module api-status"><a href="https://status.github.com" class="unknown">API Status</a></div>
3837
</div><!-- sidebar-shell -->
3938
</div><!-- #wrapper -->
40-
39+
4140
<%= render 'footer' %>
4241
</body>
4342
</html>

layouts/header.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<ul class="nav">
66
<li><a href="/" class="nav-overview">Overview</a></li>
77
<li><a href="/v3/" class="nav-api">API</a></li>
8-
<li><a href="/hooks/" class="nav-hooks">Hooks</a></li>
8+
<li><a href="/webhooks/" class="nav-webhooks">Webhooks</a></li>
99
<li><a href="/changes/" class="nav-blog">Blog</a></li>
1010
<li><a href="https://github.com/contact">Support</a></li>
1111
<li id="search-container">

static/search-index.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@
227227
},
228228
{
229229
"url": "/v3/repos/hooks/",
230-
"title": "Hooks",
230+
"title": "Webhooks",
231231
"section": "API/Repositories"
232232
},
233233
{

static/shared/css/documentation.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ a img {
324324
transition: color 0.2s ease-in-out 0s;
325325
}
326326

327-
.overview #header .nav-overview, .api #header .nav-api, .hooks #header .nav-hooks, .blog #header .nav-blog {
327+
.overview #header .nav-overview, .api #header .nav-api, .webhooks #header .nav-webhooks, .blog #header .nav-blog {
328328
color: #333;
329329
border-bottom: 3px solid #c9c9c9;
330330
}

0 commit comments

Comments
 (0)