← All resources

Resource

incoming_webhook

An incoming webhook endpoint configuration

GraphQL reference →

Configuration

nameString!Required

Display name (required)

slugString!Required

URL path segment (required, unique per tenant)

activeBoolean!Optional

Enable/disable the endpoint (default: true)

allowedMethods[WebhookHTTPMethod!]!Optional

Allowed HTTP methods (default: [POST])

Allowed values

GET — HTTP GET

POST — HTTP POST

PUT — HTTP PUT

PATCH — HTTP PATCH

DELETE — HTTP DELETE

authStrategyWebhookAuthStrategy!Optional

Authentication strategy (default: NONE)

Allowed values

NONE — No authentication (public endpoint)

API_KEY — API key header authentication

HMAC — HMAC signature verification

authConfigString!Optional

Non-secret authentication settings (JSON), e.g. hmacHeaderName. Supplying a secret key here is an error naming authSecret — this field is returned by reads, so a secret in it can be echoed back over the stored one.

JSON text, compared as data: key order and whitespace are not changes

scriptBodyString!Required

Lua script source code (required)

timeoutMsInt!Optional

Execution timeout in milliseconds (default: 5000)

botUserIdUserIDOptional

Bot user ID for webhook execution identity

References service_account

controllerIdControllerIDOptional

Controller ID for on-premise binding

References controller

authSecretStringOptional

The API key (API_KEY) or HMAC secret (HMAC). Write-only: never returned by any query. Omit — or send an empty string, which is what a blank password box submits — to leave the stored secret unchanged. To remove one, switch authStrategy to a strategy that does not use it.

write-only, never read back

Read-only values

Show values
idIncomingWebhookID!Read only

Unique identifier

computed by the platform

pathString!Read only

Route this endpoint answers on, e.g. /api/hooks/my-hook

computed by the platform

urlStringRead only

Absolute URL this endpoint is reachable at. Null when the server cannot determine one — no public base URL configured, or a controller-bound endpoint whose controller has no host recorded. Fall back to path rather than assembling an origin client-side.

computed by the platform

hasAuthSecretBoolean!Read only

Whether a secret is stored for the current strategy. Always false for NONE. The value itself is never returned.

computed by the platform

authSecretUpdatedAtISO8601Read only

When the stored secret last changed (ISO8601); null when nothing is stored, or when it was last written before the platform recorded this.

computed by the platform

createdAtString!Read only

Creation timestamp (ISO8601)

computed by the platform

updatedAtString!Read only

Last update timestamp (ISO8601)

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the existing resource is removed before its replacement is created.