Skip to content

Webhook GA docs for SG 5.7 release #610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 30, 2024
Merged

Webhook GA docs for SG 5.7 release #610

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8acfc51
docs(batches): explain credential migration (#607)
bahrmichael Aug 29, 2024
49f436a
Webhook GA docs
MaedahBatool Aug 30, 2024
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: 1 addition & 1 deletion docs/admin/config/webhooks/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Webhooks

- [Incoming webhooks](/admin/config/webhooks/incoming)
- [Outgoing webhooks](/admin/config/webhooks/outgoing) (Beta)
- [Outgoing webhooks](/admin/config/webhooks/outgoing)
2 changes: 1 addition & 1 deletion docs/admin/config/webhooks/outgoing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Outgoing webhooks

<Callout type="note"> This feature is currently in beta and supported on Sourcegraph versions 5.0 or more.</Callout>
<Callout type="note"> This feature is supported on Sourcegraph versions 5.0 or more.</Callout>

Outgoing webhooks can be configured on a Sourcegraph instance in order to send Sourcegraph events to external tools and services. This allows for deeper integrations between Sourcegraph and other applications.

Expand Down
8 changes: 8 additions & 0 deletions docs/batch-changes/configuring-credentials.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,14 @@ GitHub apps follow the same concepts as [personal and global access tokens](#typ
- GitHub apps can only be used with GitHub code hosts.
- The forking mechanism (`fork:true`) is only supported if the GitHub app has access to all repositories of the installation, and if the origin repository and the fork are in the same organization that the GitHub app is installed to ([GitHub Docs](https://docs.github.com/en/rest/repos/forks?apiVersion=2022-11-28#create-a-fork)).

### Migrating from PATs to GitHub Apps

You can migrate your credentials from PATs to GitHub Apps by deleting the PAT credential and creating a GitHub app credential.

Batch Changes will look at the available credentials, and pick one that matches the targeted namespace (e.g. organization).

You can continue to use existing batch changes without modifications.

### Adding a GitHub app

Adding a GitHub app is done through the Batch Changes section of your user settings:
Expand Down
2 changes: 1 addition & 1 deletion docs/code_monitoring/how-tos/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

* [Starting points](/code_monitoring/how-tos/starting_points)
* [Setting up Slack notifications](/code_monitoring/how-tos/slack)
* [Setting up Webhook notifications](/code_monitoring/how-tos/webhook) (Beta)
* [Setting up Webhook notifications](/code_monitoring/how-tos/webhook)
2 changes: 0 additions & 2 deletions docs/code_monitoring/how-tos/webhook.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Setting up Webhook notifications

<Callout type="note">This feature is in beta.</Callout>

Webhook notifications provide a way to execute custom responses to a code monitor notification.
They are implemented as a POST request to a URL of your choice. The body of the request is defined
by Sourcegraph, and contains all the information available about the cause of the notification.
Expand Down