UpdateIncomingWebhookInput
Input for updating an incoming webhook. Only provided fields are changed.
Fields
Display name
URL path segment (unique per tenant)
Enable/disable the endpoint
Allowed HTTP methods
Possible values (5)
GETHTTP GET
POSTHTTP POST
PUTHTTP PUT
PATCHHTTP PATCH
DELETEHTTP DELETE
Authentication strategy
Possible values (3)
NONENo authentication (public endpoint)
API_KEYAPI key header authentication
HMACHMAC signature verification
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.
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.
Lua script source code
Execution timeout in milliseconds
Bot user ID for webhook execution identity
Controller ID for on-premise binding
Referenced by (1)
Exact type SDL
"""
Input for updating an incoming webhook. Only provided fields are changed.
"""
input UpdateIncomingWebhookInput {
"""Display name"""
name: String
"""URL path segment (unique per tenant)"""
slug: String
"""Enable/disable the endpoint"""
active: Boolean
"""Allowed HTTP methods"""
allowedMethods: [WebhookHTTPMethod!]
"""Authentication strategy"""
authStrategy: WebhookAuthStrategy
"""
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.
"""
authConfig: String
"""
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.
"""
authSecret: String @sensitive @iac_writeOnly(presence: "hasAuthSecret", updatedAt: "authSecretUpdatedAt")
"""Lua script source code"""
scriptBody: String
"""Execution timeout in milliseconds"""
timeoutMs: Int
"""Bot user ID for webhook execution identity"""
botUserId: UserID
"""Controller ID for on-premise binding"""
controllerId: ControllerID
}