Skip to content

Type Alias: Webhook ​

Webhook = object

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3728

Webhook

Properties ​

$createdAt ​

$createdAt: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3736

Webhook creation date in ISO 8601 format.


$id ​

$id: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3732

Webhook ID.


$updatedAt ​

$updatedAt: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3740

Webhook update date in ISO 8601 format.


attempts ​

attempts: number

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3780

Number of consecutive failed webhook attempts.


enabled ​

enabled: boolean

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3772

Indicates if this webhook is enabled.


events ​

events: string[]

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3752

Webhook trigger events.


httpPass ​

httpPass: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3764

HTTP basic authentication password.


httpUser ​

httpUser: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3760

HTTP basic authentication username.


logs ​

logs: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3776

Webhook error logs from the most recent failure.


name ​

name: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3744

Webhook name.


security ​

security: boolean

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3756

Indicated if SSL / TLS Certificate verification is enabled.


signatureKey ​

signatureKey: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3768

Signature key which can be used to validated incoming


url ​

url: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3748

Webhook URL endpoint.