# Webhook

Configure webhook endpoints

* [`sfp server webhook delete`](#sfp-server-webhook-delete)
* [`sfp server webhook get`](#sfp-server-webhook-get)
* [`sfp server webhook list`](#sfp-server-webhook-list)
* [`sfp server webhook register`](#sfp-server-webhook-register)
* [`sfp server webhook trigger-event`](#sfp-server-webhook-trigger-event)
* [`sfp server webhook update`](#sfp-server-webhook-update)

## `sfp server webhook delete`

Delete a webhook

```
USAGE
  $ sfp server webhook delete -i <value> [--json] [--repository <value>] [-e <value>] [-t <value>] [--sfp-server-url
    <value>]

FLAGS
  -e, --email=<value>              Email address for authenticated user. Ignored if --application-token is provided. Can
                                   be set via SFP_SERVER_USER env var.
  -i, --id=<value>                 (required) ID of the webhook to delete
  -t, --application-token=<value>  Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                   (CLI flags take precedence over env vars).
      --repository=<value>         The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                   for Azure DevOps
      --sfp-server-url=<value>     URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                   config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Delete a webhook

EXAMPLES
  $ sfp server webhook delete --id webhook-id --email user@example.com

  $ sfp server webhook delete --id webhook-id --application-token myToken
```

*See code:* [*src/commands/server/webhook/delete.ts*](https://source.flxbl.io/flxbl/sfp-pro)

## `sfp server webhook get`

Get details of a webhook

```
USAGE
  $ sfp server webhook get -i <value> [--json] [--repository <value>] [-e <value>] [-t <value>] [--sfp-server-url
    <value>]

FLAGS
  -e, --email=<value>              Email address for authenticated user. Ignored if --application-token is provided. Can
                                   be set via SFP_SERVER_USER env var.
  -i, --id=<value>                 (required) ID of the webhook to retrieve
  -t, --application-token=<value>  Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                   (CLI flags take precedence over env vars).
      --repository=<value>         The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                   for Azure DevOps
      --sfp-server-url=<value>     URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                   config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Get details of a webhook

EXAMPLES
  $ sfp server webhook get --id webhook-id --email user@example.com

  $ sfp server webhook get --id webhook-id --application-token myToken
```

*See code:* [*src/commands/server/webhook/get.ts*](https://source.flxbl.io/flxbl/sfp-pro)

## `sfp server webhook list`

List all registered webhooks

```
USAGE
  $ sfp server webhook list [--json] [--repository <value>] [-e <value>] [-t <value>] [--sfp-server-url <value>]

FLAGS
  -e, --email=<value>              Email address for authenticated user. Ignored if --application-token is provided. Can
                                   be set via SFP_SERVER_USER env var.
  -t, --application-token=<value>  Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                   (CLI flags take precedence over env vars).
      --repository=<value>         The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                   for Azure DevOps
      --sfp-server-url=<value>     URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                   config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List all registered webhooks

EXAMPLES
  $ sfp server webhook list --email user@example.com

  $ sfp server webhook list --application-token myToken
```

*See code:* [*src/commands/server/webhook/list.ts*](https://source.flxbl.io/flxbl/sfp-pro)

## `sfp server webhook register`

Register a new webhook

```
USAGE
  $ sfp server webhook register -f <value> [--json] [--repository <value>] [-e <value>] [-t <value>] [--sfp-server-url
    <value>]

FLAGS
  -e, --email=<value>              Email address for authenticated user. Ignored if --application-token is provided. Can
                                   be set via SFP_SERVER_USER env var.
  -f, --file=<value>               (required) Path to JSON file containing webhook configuration
  -t, --application-token=<value>  Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                   (CLI flags take precedence over env vars).
      --repository=<value>         The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                   for Azure DevOps
      --sfp-server-url=<value>     URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                   config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Register a new webhook

EXAMPLES
  $ sfp server webhook register --file webhook-config.json --email user@example.com

  $ sfp server webhook register --file webhook-config.json --application-token myToken
```

*See code:* [*src/commands/server/webhook/register.ts*](https://source.flxbl.io/flxbl/sfp-pro)

## `sfp server webhook trigger-event`

Test a webhook by sending a test event

```
USAGE
  $ sfp server webhook trigger-event --event <value> -f <value> [--json] [--repository <value>] [-e <value>] [-t <value>]
    [--sfp-server-url <value>]

FLAGS
  -e, --email=<value>              Email address for authenticated user. Ignored if --application-token is provided. Can
                                   be set via SFP_SERVER_USER env var.
  -f, --file=<value>               (required) Path to JSON file containing the test payload
  -t, --application-token=<value>  Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                   (CLI flags take precedence over env vars).
      --event=<value>              (required) Event name to test
      --repository=<value>         The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                   for Azure DevOps
      --sfp-server-url=<value>     URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                   config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Test a webhook by sending a test event

EXAMPLES
  $ sfp server webhook trigger-event --event release.succeeded --file test-payload.json --email user@example.com

  $ sfp server webhook test-event --event release.succeeded --file test-payload.json --application-token myToken
```

*See code:* [*src/commands/server/webhook/trigger-event.ts*](https://source.flxbl.io/flxbl/sfp-pro)

## `sfp server webhook update`

Update an existing webhook

```
USAGE
  $ sfp server webhook update -i <value> -f <value> [--json] [--repository <value>] [-e <value>] [-t <value>]
    [--sfp-server-url <value>]

FLAGS
  -e, --email=<value>              Email address for authenticated user. Ignored if --application-token is provided. Can
                                   be set via SFP_SERVER_USER env var.
  -f, --file=<value>               (required) Path to JSON file containing the webhook configuration
  -i, --id=<value>                 (required) ID of the webhook to update
  -t, --application-token=<value>  Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                   (CLI flags take precedence over env vars).
      --repository=<value>         The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                   for Azure DevOps
      --sfp-server-url=<value>     URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                   config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Update an existing webhook

EXAMPLES
  $ sfp server webhook update --id webhook-id --file webhook-config.json --email user@example.com

  $ sfp server webhook update --id webhook-id --file webhook-config.json --application-token myToken
```

*See code:* [*src/commands/server/webhook/update.ts*](https://source.flxbl.io/flxbl/sfp-pro)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.flxbl.io/flxbl/sfp/cli-reference-v51-release-v3/server/webhook.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.