autessa.customWebhooks
8 methods in the customWebhooks namespace.
autessa.customWebhooks.createMUTATE
autessa.customWebhooks.create({ webhookConfig })Create an inbound webhook that runs a tool, agent, manager, or AutessaDB operation when its public URL is called; the response returns its API key exactly once.
webhookConfig.name is required and the call fails without it. A dedicated webhook API key is minted server-side; the new webhook is enabled by default and owned by you. webhookConfig carries the payload-transform config (JSONPath mappings or an AutessaScript transform script — see autessaScript — that turns the inbound request into named variables), an optional validation script, the resourceExecutionConfig naming the target resource and its variable maps (which support @@{name} substitution from the transformed payload), and execution settings. The invoke URL is not returned: it is constructed as any HTTP method to /clients/custom-webhooks?resourceId={webhookId}&auth={apiKey}. The apiKey field is the only time the full key value is exposed — store it now. Inbound calls are queued and processed asynchronously (HTTP 202 = accepted, not succeeded); check customWebhooks.getExecutionHistory for outcomes.
Request fields
- Name
webhookConfig- Type
- WebhookConfig
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
webhook- Type
- CustomWebhookDto
- Description
- Name
apiKey- Type
- string
- Description
autessa.customWebhooks.deleteMUTATE
autessa.customWebhooks.delete({ webhookId })Permanently delete a webhook (hard delete; owner only — ADMIN share access is not enough).
Irreversible. Only the webhook's owner may delete it; even an ADMIN-level share grant is rejected. The webhook stops accepting inbound calls immediately and its execution history is removed. deleted is true when the delete took effect.
Request fields
- Name
webhookId- Type
- string (opaque id)
- Description
- References custom webhook by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
deleted- Type
- boolean
- Description
autessa.customWebhooks.getREAD
autessa.customWebhooks.get({ webhookId })Fetch one webhook's configuration by id (the API key value is never returned, only its id).
Requires any access level (READ or above) on the webhook; otherwise the call is unauthorized. Returns the full webhook, including its resolved userAccessLevel, but never the secret key value — only apiKeyId.
Request fields
- Name
webhookId- Type
- string (opaque id)
- Description
- References custom webhook by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
webhook- Type
- CustomWebhookDto
- Description
autessa.customWebhooks.getAllREAD
autessa.customWebhooks.getAll()List every webhook you can access in the current company.
Returns all webhooks you own plus those shared with you (company-wide or per-user) in the current company. Takes no arguments and is not paginated; each entry carries your userAccessLevel but never a key value.
Request fields
No fields.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
webhooks- Type
- CustomWebhookDto[]
- Description
autessa.customWebhooks.getExecutionHistoryREAD
autessa.customWebhooks.getExecutionHistory({ webhookId, status, page, size })Page through a webhook's inbound execution history (status, timing, attempt number, and decrypted execution details), newest-page first; page is 0-based.
Requires any access level (READ or above) on the webhook. Pagination is zero-based: page defaults to 0 and size to 20. An optional status filter narrows results to a single EWebhookExecutionStatus value (queued, processing, success, failed, transform_failed). Each entry's stored execution details are decrypted before return. Continue paging until currentPage + 1 reaches totalPages.
Request fields
- Name
webhookId- Type
- string (opaque id)
- Description
- References custom webhook by opaque id.
- Name
status- Type
- string
- Description
- Name
page- Type
- number
- Description
- Name
size- Type
- number
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
history- Type
- WebhookExecutionHistoryDto[]
- Description
- Name
totalPages- Type
- number
- Description
- Name
totalElements- Type
- number
- Description
- Name
currentPage- Type
- number
- Description
autessa.customWebhooks.refreshApiKeyMUTATE
autessa.customWebhooks.refreshApiKey({ webhookId })Rotate a webhook's API key: the old key stops working immediately and the new key is returned exactly once (ADMIN only).
Credential rotation. Requires ADMIN access on the webhook. Any external system still configured with the old key breaks the moment this returns — update the caller with the new key value promptly. The returned apiKey is the only time the new full key value is exposed; it cannot be retrieved again.
Request fields
- Name
webhookId- Type
- string (opaque id)
- Description
- References custom webhook by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
apiKey- Type
- string
- Description
autessa.customWebhooks.updateMUTATE
autessa.customWebhooks.update({ webhookId, webhookConfig, isEnabled })Update a webhook's configuration and/or its enabled flag by submitting the complete webhookConfig (read with customWebhooks.get, modify, submit).
Requires WRITE, PUBLISH, or ADMIN access — READ is not enough. webhookConfig is written wholesale: it replaces the stored configuration, so start from customWebhooks.get's webhook.webhookConfig so unmentioned fields survive. isEnabled is optional; when omitted the current enabled state is kept. The API key is unaffected (use customWebhooks.refreshApiKey to rotate it).
Request fields
- Name
webhookId- Type
- string (opaque id)
- Description
- References custom webhook by opaque id.
- Name
webhookConfig- Type
- WebhookConfig
- Description
- Name
isEnabled- Type
- boolean
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
webhook- Type
- CustomWebhookDto
- Description