Appearance
IncomingWebhookState
Type: Object
An incoming webhook endpoint configuration
Fields
| Name | Type | Args | Description | Deprecated |
|---|---|---|---|---|
| active | Boolean! | Whether the endpoint is enabled | ||
| allowedMethods | [WebhookHTTPMethod!]! | HTTP methods this endpoint accepts | ||
| authConfig | String! | 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. | ||
| authSecretUpdatedAt | ISO8601 | When the stored secret last changed (ISO8601); null when nothing is stored, or when it was last written before the platform recorded this. | ||
| authStrategy | WebhookAuthStrategy! | Authentication strategy | ||
| botUserId | UserID | Bot user ID for webhook execution identity | ||
| controllerId | ControllerID | Controller ID for on-premise binding | ||
| createdAt | String! | Creation timestamp (ISO8601) | ||
| hasAuthSecret | Boolean! | Whether a secret is stored for the current strategy. Always false for NONE. The value itself is never returned. | ||
| id | IncomingWebhookID! | Unique identifier | ||
| name | String! | Display name for the webhook | ||
| path | String! | Route this endpoint answers on, e.g. /api/hooks/my-hook | ||
| scriptBody | String! | Lua script to execute when the endpoint is called | ||
| slug | String! | URL path segment (used in /api/hooks/{slug}) | ||
| timeoutMs | Int! | Execution timeout in milliseconds | ||
| updatedAt | String! | Last update timestamp (ISO8601) | ||
| url | String | 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. |