Resource
incoming_webhook
An incoming webhook endpoint configuration
Configuration
nameString!RequiredDisplay name (required)
slugString!RequiredURL path segment (required, unique per tenant)
activeBoolean!OptionalEnable/disable the endpoint (default: true)
allowedMethods[WebhookHTTPMethod!]!OptionalAllowed HTTP methods (default: [POST])
Allowed values
GET — HTTP GET
POST — HTTP POST
PUT — HTTP PUT
PATCH — HTTP PATCH
DELETE — HTTP DELETE
authStrategyWebhookAuthStrategy!OptionalAuthentication strategy (default: NONE)
Allowed values
NONE — No authentication (public endpoint)
API_KEY — API key header authentication
HMAC — HMAC signature verification
authConfigString!OptionalNon-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!RequiredLua script source code (required)
timeoutMsInt!OptionalExecution timeout in milliseconds (default: 5000)
botUserIdUserIDOptionalBot user ID for webhook execution identity
References service_account
controllerIdControllerIDOptionalController ID for on-premise binding
References controller
authSecretStringOptionalThe 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 onlyUnique identifier
computed by the platform
pathString!Read onlyRoute this endpoint answers on, e.g. /api/hooks/my-hook
computed by the platform
urlStringRead onlyAbsolute 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 onlyWhether a secret is stored for the current strategy. Always false for NONE. The value itself is never returned.
computed by the platform
authSecretUpdatedAtISO8601Read onlyWhen 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 onlyCreation timestamp (ISO8601)
computed by the platform
updatedAtString!Read onlyLast 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.