Skip to content

IncomingWebhookState ​

Type: Object

An incoming webhook endpoint configuration

Fields ​

NameTypeArgsDescriptionDeprecated
activeBoolean!Whether the endpoint is enabled
allowedMethods[WebhookHTTPMethod!]!HTTP methods this endpoint accepts
authConfigString!Non-secret authentication settings (JSON), e.g. hmacHeaderName. The secret itself is never returned in any form — not even masked, because a masked value is still one a client can send back over the stored one. Whether a secret is set is answered by hasAuthSecret.
authSecretUpdatedAtISO8601When the stored secret last changed (ISO8601); null when nothing is stored, or when it was last written before the platform recorded this.
authStrategyWebhookAuthStrategy!Authentication strategy
botUserIdUserIDBot user ID for webhook execution identity
controllerIdControllerIDController ID for on-premise binding
createdAtString!Creation timestamp (ISO8601)
hasAuthSecretBoolean!Whether a secret is stored for the current strategy. Always false for NONE. The value itself is never returned.
idIncomingWebhookID!Unique identifier
nameString!Display name for the webhook
pathString!Route this endpoint answers on, e.g. /api/hooks/my-hook
scriptBodyString!Lua script to execute when the endpoint is called
slugString!URL path segment (used in /api/hooks/{slug})
timeoutMsInt!Execution timeout in milliseconds
updatedAtString!Last update timestamp (ISO8601)
urlStringAbsolute 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.

Connect machines, automate workflows, and build custom apps for print production.