Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/actions/listWorkflowRunsForRepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.

This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.

```js
octokit.rest.actions.listWorkflowRunsForRepo({
owner,
Expand Down
7 changes: 6 additions & 1 deletion docs/orgs/createWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,12 @@ type: API method

# Create an organization webhook

Here's how you can create a hook that posts payloads in JSON format:
Create a hook that posts payloads in JSON format.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or
edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

```js
octokit.rest.orgs.createWebhook({
Expand Down
5 changes: 5 additions & 0 deletions docs/orgs/deleteWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ type: API method

# Delete an organization webhook

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

```js
octokit.rest.orgs.deleteWebhook({
org,
Expand Down
8 changes: 7 additions & 1 deletion docs/orgs/getWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,13 @@ type: API method

# Get an organization webhook

Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)."
Returns a webhook configured in an organization. To get only the webhook
`config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

```js
octokit.rest.orgs.getWebhook({
Expand Down
5 changes: 4 additions & 1 deletion docs/orgs/getWebhookConfigForOrg.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ type: API method

Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)."

OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.
You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

```js
octokit.rest.orgs.getWebhookConfigForOrg({
Expand Down
5 changes: 5 additions & 0 deletions docs/orgs/getWebhookDelivery.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ type: API method

Returns a delivery for a webhook configured in an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

```js
octokit.rest.orgs.getWebhookDelivery({
org,
Expand Down
5 changes: 5 additions & 0 deletions docs/orgs/listWebhookDeliveries.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ type: API method

Returns a list of webhook deliveries for a webhook configured in an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

```js
octokit.rest.orgs.listWebhookDeliveries({
org,
Expand Down
5 changes: 5 additions & 0 deletions docs/orgs/listWebhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ type: API method

# List organization webhooks

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

```js
octokit.rest.orgs.listWebhooks({
org,
Expand Down
8 changes: 7 additions & 1 deletion docs/orgs/pingWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,13 @@ type: API method

# Ping an organization webhook

This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.
This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)
to be sent to the hook.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

```js
octokit.rest.orgs.pingWebhook({
Expand Down
5 changes: 5 additions & 0 deletions docs/orgs/redeliverWebhookDelivery.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ type: API method

Redeliver a delivery for a webhook configured in an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

```js
octokit.rest.orgs.redeliverWebhookDelivery({
org,
Expand Down
11 changes: 10 additions & 1 deletion docs/orgs/updateWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,16 @@ type: API method

# Update an organization webhook

Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)."
Updates a webhook configured in an organization. When you update a webhook,
the `secret` will be overwritten. If you previously had a `secret` set, you must
provide the same `secret` or set a new `secret` or the secret will be removed. If
you are only updating individual webhook `config` properties, use "[Update a webhook
configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)".

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

```js
octokit.rest.orgs.updateWebhook({
Expand Down
5 changes: 4 additions & 1 deletion docs/orgs/updateWebhookConfigForOrg.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ type: API method

Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)."

OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.
You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

```js
octokit.rest.orgs.updateWebhookConfigForOrg({
Expand Down
16 changes: 8 additions & 8 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"author": "Gregor Martynus (https://twitter.com/gr2m)",
"license": "MIT",
"dependencies": {
"@octokit/types": "^13.1.0"
"@octokit/types": "^13.3.0"
},
"devDependencies": {
"@octokit/core": "^6.0.0",
Expand Down
Loading