Skip to content
CCS Files Docs

WebhookInput

Defined in: libs/ccs-files-client/src/types.ts:980

Properties

Section titled “Properties”

url

Section titled “url”

url: string

Defined in: libs/ccs-files-client/src/types.ts:985

An absolute https URL without credentials, at most 2,048 characters, on a public address (a private, loopback or link-local address answers 400 webhook_url_not_allowed).

secret?

Section titled “secret?”

optional secret?: string

Defined in: libs/ccs-files-client/src/types.ts:987

Write-only, 16 to 256 characters; required the first time, kept when left out. Signs deliveries (X-Files-Signature).

events

Section titled “events”

events: string[]

Defined in: libs/ccs-files-client/src/types.ts:988

active?

Section titled “active?”

optional active?: boolean

Defined in: libs/ccs-files-client/src/types.ts:990

Default true: the service pings the URL first and saves only when it answers 2xx (else 422 webhook_unreachable).