Docs
flxbl.ioStatusContact us
codevsfp CLIsfp serverlibraries

Webhook

Manage webhooks in sfp server

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>              [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                   --application-token is provided.
  -i, --id=<value>                 (required) ID of the webhook to delete
  -t, --application-token=<value>  [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                   over --email.
      --repository=<value>         The repository identifier. E.g `owner/repo`
      --sfp-server-url=<value>     [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                   `SFP_SERVER_URL` 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

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>              [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                   --application-token is provided.
  -i, --id=<value>                 (required) ID of the webhook to retrieve
  -t, --application-token=<value>  [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                   over --email.
      --repository=<value>         The repository identifier. E.g `owner/repo`
      --sfp-server-url=<value>     [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                   `SFP_SERVER_URL` 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

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>              [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                   --application-token is provided.
  -t, --application-token=<value>  [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                   over --email.
      --repository=<value>         The repository identifier. E.g `owner/repo`
      --sfp-server-url=<value>     [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                   `SFP_SERVER_URL` 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

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>              [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                   --application-token is provided.
  -f, --file=<value>               (required) Path to JSON file containing webhook configuration
  -t, --application-token=<value>  [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                   over --email.
      --repository=<value>         The repository identifier. E.g `owner/repo`
      --sfp-server-url=<value>     [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                   `SFP_SERVER_URL` 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

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>              [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                   --application-token is provided.
  -f, --file=<value>               (required) Path to JSON file containing the test payload
  -t, --application-token=<value>  [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                   over --email.
      --event=<value>              (required) Event name to test
      --repository=<value>         The repository identifier. E.g `owner/repo`
      --sfp-server-url=<value>     [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                   `SFP_SERVER_URL` 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

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>              [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                   --application-token is provided.
  -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>  [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                   over --email.
      --repository=<value>         The repository identifier. E.g `owner/repo`
      --sfp-server-url=<value>     [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                   `SFP_SERVER_URL` 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

User

Previous Page

Utilities

Next Page

On this page

sfp server webhook deletesfp server webhook getsfp server webhook listsfp server webhook registersfp server webhook trigger-eventsfp server webhook update