webhooks

package

v7.2.0 Latest Latest Go to latest Published: Sep 2, 2026 License: BSD-3-Clause Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/appwrite/sdk-for-go

Links

Open Source Insights

Documentation ¶

Index ¶

type CreateOption
type CreateOptions
- func (options CreateOptions) New() *CreateOptions
type ListOption
type ListOptions
- func (options ListOptions) New() *ListOptions
type UpdateOption
type UpdateOptions
- func (options UpdateOptions) New() *UpdateOptions
type UpdateSecretOption
type UpdateSecretOptions
- func (options UpdateSecretOptions) New() *UpdateSecretOptions
type Webhooks
- func New(clt client.Client) *Webhooks

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type CreateOption ¶

type CreateOption func(*CreateOptions)

type CreateOptions ¶

type CreateOptions struct {
	Enabled      bool
	Tls          bool
	AuthUsername string
	AuthPassword string
	Secret       string
	// contains filtered or unexported fields
}

func (CreateOptions) New ¶

func (options CreateOptions) New() *CreateOptions

type ListOption ¶

type ListOption func(*ListOptions)

type ListOptions ¶

type ListOptions struct {
	Queries []string
	Total   bool
	// contains filtered or unexported fields
}

func (ListOptions) New ¶

func (options ListOptions) New() *ListOptions

type UpdateOption ¶

type UpdateOption func(*UpdateOptions)

type UpdateOptions ¶

type UpdateOptions struct {
	Enabled      bool
	Tls          bool
	AuthUsername string
	AuthPassword string
	// contains filtered or unexported fields
}

func (UpdateOptions) New ¶

func (options UpdateOptions) New() *UpdateOptions

type UpdateSecretOption ¶

type UpdateSecretOption func(*UpdateSecretOptions)

type UpdateSecretOptions ¶

type UpdateSecretOptions struct {
	Secret string
	// contains filtered or unexported fields
}

func (UpdateSecretOptions) New ¶

func (options UpdateSecretOptions) New() *UpdateSecretOptions

type Webhooks ¶

type Webhooks struct {
	// contains filtered or unexported fields
}

Webhooks service

func New ¶

func New(clt client.Client) *Webhooks

func (*Webhooks) Create ¶

func (srv *Webhooks) Create(WebhookId string, Url string, Name string, Events []string, optionalSetters ...CreateOption) (*models.Webhook, error)

Create create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.

func (*Webhooks) Delete ¶

func (srv *Webhooks) Delete(WebhookId string) (*interface{}, error)

Delete delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events.

func (*Webhooks) Get ¶

func (srv *Webhooks) Get(WebhookId string) (*models.Webhook, error)

Get get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project.

func (*Webhooks) List ¶

func (srv *Webhooks) List(optionalSetters ...ListOption) (*models.WebhookList, error)

List get a list of all webhooks belonging to the project. You can use the query params to filter your results.

func (*Webhooks) Update ¶

func (srv *Webhooks) Update(WebhookId string, Name string, Url string, Events []string, optionalSetters ...UpdateOption) (*models.Webhook, error)

Update update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.

func (*Webhooks) UpdateSecret ¶

func (srv *Webhooks) UpdateSecret(WebhookId string, optionalSetters ...UpdateSecretOption) (*models.Webhook, error)

UpdateSecret update the webhook signing key. This endpoint can be used to regenerate the signing key used to sign and validate payload deliveries for a specific webhook.

func (*Webhooks) WithCreateAuthPassword ¶

func (srv *Webhooks) WithCreateAuthPassword(v string) CreateOption

func (*Webhooks) WithCreateAuthUsername ¶

func (srv *Webhooks) WithCreateAuthUsername(v string) CreateOption

func (*Webhooks) WithCreateEnabled ¶

func (srv *Webhooks) WithCreateEnabled(v bool) CreateOption

func (*Webhooks) WithCreateSecret ¶

func (srv *Webhooks) WithCreateSecret(v string) CreateOption

func (*Webhooks) WithCreateTls ¶

func (srv *Webhooks) WithCreateTls(v bool) CreateOption

func (*Webhooks) WithListQueries ¶

func (srv *Webhooks) WithListQueries(v []string) ListOption

func (*Webhooks) WithListTotal ¶

func (srv *Webhooks) WithListTotal(v bool) ListOption

func (*Webhooks) WithUpdateAuthPassword ¶

func (srv *Webhooks) WithUpdateAuthPassword(v string) UpdateOption

func (*Webhooks) WithUpdateAuthUsername ¶

func (srv *Webhooks) WithUpdateAuthUsername(v string) UpdateOption

func (*Webhooks) WithUpdateEnabled ¶

func (srv *Webhooks) WithUpdateEnabled(v bool) UpdateOption

func (*Webhooks) WithUpdateSecretSecret ¶

func (srv *Webhooks) WithUpdateSecretSecret(v string) UpdateSecretOption

func (*Webhooks) WithUpdateTls ¶

func (srv *Webhooks) WithUpdateTls(v bool) UpdateOption

Source Files ¶

View all Source files

webhooks.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL