Webhooks class

The Webhooks service allows you to manage your project webhooks.

Constructors

Webhooks(Client client)

Properties

client → Client
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

create({required String webhookId, required String url, required String name, required List<String> events, bool? enabled, bool? tls, String? authUsername, String? authPassword, String? secret}) → Future<Webhook>
Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.
delete({required String webhookId}) → Future
Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events.
get({required String webhookId}) → Future<Webhook>
Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project.
list({List<String>? queries, bool? total}) → Future<WebhookList>
Get a list of all webhooks belonging to the project. You can use the query params to filter your results.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
update({required String webhookId, required String name, required String url, required List<String> events, bool? enabled, bool? tls, String? authUsername, String? authPassword}) → Future<Webhook>
Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.
updateSecret({required String webhookId, String? secret}) → Future<Webhook>
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.

Operators

operator ==(Object other) → bool
The equality operator.
inherited