All servers / Developer / Avallon MCP server
Avallon MCP server
Avallon API MCP server - generated from OpenAPI
Tested by ConnectATDScore 78 out of 100. Tested 2026-11-18 on package version 69.0.0. Package: @avallon-labs/mcp
Score breakdown
| Runs | 18 / 20 | |
|---|---|---|
| Tool descriptions | 12 / 20 | |
| Package safety | 16 / 20 | |
| Maintenance | 20 / 20 | |
| Adoption | 12 / 20 |
What we saw
- Starts and answers the MCP handshake: yes (3.2 seconds including download)
- Tools offered: 217
- Last published: 2026-11-17
- Weekly downloads (npm): 5,038
- License: MIT · Direct dependencies: 2
Want this server set up for your team?
ConnectATD builds AI automation and wires up MCP servers like this one. Tell us what you are trying to do.
Talk to ConnectATDTools and how they are described
Agents choose tools from these descriptions. Under each name you can see how many of its parameters are explained.
listVoiceAgents0 of 1 parameter describedList all voice agents for your tenant. **Filtering:** Filter voice agents by name using the `agent_name` query parameter (exact match). **Response:** Returns an array of all voice agents with their configurations and a total count. For compatibility this endpoint is also available using the following (deprecated) paths: `GET /v1/agents`
createVoiceAgent0 of 1 parameter describedCreate a new voice agent with the specified configuration. **Required fields:** Provide `engine`: a `pipeline` of STT, LLM and TTS models, or a `speech_to_speech` model such as `gpt-live-1`. The flat `llm_model`, `tts_provider`, `tts_model`, `tts_voice_id` and `stt_model` fields are deprecated; they still create a pipeline agent but cannot be combined with `engine`. All other fields are required except `phone_number_id` and `transfer_phone_number`. **Response:** Returns the created voice agent with its ID and configuration. For compatibility this endpoint is also available using the following (deprecated) paths: `POST /v1/agents`
getVoiceAgent0 of 1 parameter describedRetrieve a single voice agent by its ID. For compatibility this endpoint is also available using the following (deprecated) paths: `GET /v1/agents/{id}`
updateVoiceAgent0 of 2 parameters describedUpdate a voice agent. Only the fields you send change; omitted fields keep their current value. To change the processor assignment, `call_processor_id` and `call_processor_type` must be provided together. Set `call_processor_id` to `null` to detach (`call_processor_type` is still required). Set `engine` to replace the whole model setup: `pipeline` (STT, LLM and TTS models plus optional fallbacks) or `speech_to_speech` (`gpt-live-1` and a voice). For `gpt-live-1`, `prompt` is the reasoner prompt and `speaker_instructions` the speaker prompt. The flat model fields (`llm_model`, `tts_provider`, `tts_model`, `tts_voice_id`, `stt_model` and their `fallback_*` counterparts) are deprecated and only work on pipeline agents. They cannot be combined with `engine`. They are validated against the resulting configuration, so a single field such as `tts_voice_id` can be sent on its own. Set `voice_mail_detection` to `true` to have the agent listen for a voicemail beep tone. Detection only runs on `OUTBOUND` agents; enabling it on an `INBOUND` agent is stored but has no effect. Set `max_call_duration_seconds` to change how long a call may run before the agent ends it (default 1800). Set `background_sounds` to `disabled` to turn off the ambient office background sounds played during calls. Set `noise_cancellation` to choose the noise cancellation mode applied to the caller audio. Set `tool_ids` to replace the agent's attached tool set. This is the supported way to manage tool attachments; the dedicated add and remove endpoints are deprecated. Set `evaluator_slug` to score the agent's calls with that evaluator. Calls only use it once the new version is promoted, because a call is evaluated with the version it ran on. All changes in one request create a single new voice agent config version. The live and test releases keep pointing at their current versions until the new version is promoted.
deleteVoiceAgent0 of 1 parameter describedDelete a voice agent. The agent is hidden from all reads; its call and job history is preserved.
listVoiceAgentVersions0 of 2 parameters describedList all config versions for a voice agent, ordered by version (newest first by default).
getVoiceAgentVersion0 of 1 parameter describedRetrieve a single voice agent config version, including the agent's identity, the config snapshot at that version, and version-specific metadata.
promoteVoiceAgentVersion0 of 2 parameters describedSelect a voice agent configuration version for the live or test environment.
getVoiceAgentVersionChangeSummary0 of 1 parameter describedReturns an AI-generated summary of what changed between this version and the previous one. Initial version returns an empty string since there is no predecessor.
getVoiceAgentPlaceholders0 of 1 parameter describedRetrieve the available placeholder variables defined in a voice agent's prompt. For compatibility this endpoint is also available using the following (deprecated) paths: `GET /v1/agents/{id}/prompt`
getVoiceAgentPrompt0 of 2 parameters describedRetrieve the prompt for a voice agent. Pass `version` to fetch the prompt snapshot at a specific config version; omit it to fetch the current prompt. Internal use only.
updateVoiceAgentPrompt0 of 2 parameters describedUpdate the prompt for a voice agent. Internal use only. **Deprecated:** Use `PATCH /v1/voice-agents/{voiceAgentId}` instead.
updateVoiceAgentModels0 of 2 parameters describedUpdate the LLM, TTS, and STT model configuration for a voice agent. **Deprecated:** Use `PATCH /v1/voice-agents/{voiceAgentId}` instead. For compatibility this endpoint is also available using the following (deprecated) paths: `PATCH /v1/agents/{id}/models`
updateCallControls0 of 2 parameters describedUpdate call control settings for a voice agent. Configure whether the voice agent supports dial pad input, can end calls, and set a transfer phone number. **Deprecated:** Use `PATCH /v1/voice-agents/{voiceAgentId}` instead. For compatibility this endpoint is also available using the following (deprecated) paths: `PUT /v1/agents/{id}/call-controls`
scheduleJob0 of 2 parameters described**Deprecated:** use `POST /v1/calls`, which returns the call itself. Schedule a new outbound call job for a voice agent. The job can be scheduled for a future time or triggered immediately with `trigger_immediately: true`. **Scheduling:** When scheduling for a future time, provide `scheduled_at` (ISO 8601) and optionally `schedule_window_minutes` (minimum 10 minutes). **Environment:** `environment` selects which promoted agent configuration and phone binding the call dispatches against (`live` or `test`). Defaults to `live`. Scheduling fails when the selected environment has no active promotion. For compatibility this endpoint is also available using the following (deprecated) paths: `POST /v1/agents/{id}/jobs`
listJobs0 of 1 parameter described**Deprecated:** use `GET /v1/calls?state=scheduled,in_progress,ended,canceled,failed`, which also filters by `scheduled_after` / `scheduled_before`. `GET /v1/calls/{id}` returns a call's `payload`. List all outbound jobs with pagination and filtering. **Filtering:** - Filter by agent ID, status, or scheduled time range. - Multiple statuses can be comma-separated (e.g. `status=pending,queued`). For compatibility this endpoint is also available using the following (deprecated) paths: `GET /v1/agents/jobs`
cancelJob0 of 1 parameter described**Deprecated:** use `POST /v1/calls/{id}/cancel`. Cancel a pending or queued outbound job. Jobs that are already in progress or completed cannot be canceled. For compatibility this endpoint is also available using the following (deprecated) paths: `POST /v1/agents/jobs/{id}/cancel`
listApiKeys0 of 1 parameter describedList all API keys for your tenant. By default, revoked keys are excluded. Set `include_revoked=true` to include them. **Note:** The full API key value is never returned — only the key prefix is shown.
createApiKey0 of 1 parameter describedCreate a new API key for authenticating with the Avallon API. **Important:** The full API key is only returned once in the response. Store it securely — it cannot be retrieved again. Keys are scoped to an environment (`test` or `live`) and optionally accept an expiration date.
revokeApiKey0 of 1 parameter describedRevoke an existing API key. Once revoked, the key can no longer be used for authentication. This operation is irreversible — revoked keys cannot be re-enabled. Create a new key if needed. Returns 409 if the key is already revoked, 404 if the key does not exist.
updateApiKey0 of 2 parameters describedUpdate mutable fields of an API key. Currently only `role` can be updated. The caller's role caps the maximum role they can grant — an `admin` cannot promote a key to `avallon_admin`.
createArtifact0 of 1 parameter describedUpload a document as a base64-encoded artifact for processing. **Limits:** Maximum file size is approximately 6.75MB (base64 encoded). The API Gateway has a 10MB request limit. **Processing options:** - `file_password`: Password for encrypted PDFs - `file_splitting_enabled`: Split multi-page PDFs into separate artifacts
listArtifacts0 of 1 parameter describedList all artifacts with pagination, filtering, and sorting. **Case Filtering:** Use `case_id` to return only artifacts linked to a case. This reads the case links created via `POST /v1/cases/{caseId}/links`, and is independent of any `metadata.case_id` an artifact may carry. **Metadata Filtering:** Use bracket notation to filter by metadata keys: - `metadata[claim_id]=abc-123` - `metadata[source]=email` Multiple metadata filters can be combined (AND logic).
getArtifact0 of 1 parameter describedRetrieve a single artifact by ID, including its metadata, file URL, extracted content, and chunk-annotated content. The response always includes `content_with_chunkids_md`: the parsed content annotated with `[chunk_id=...]` markers when the artifact has parsed chunks. Chunk IDs are stable citation anchors — cite them to attribute extracted values to their source location.
deleteArtifact0 of 1 parameter describedSoft-delete an artifact. Soft-deleted artifacts and their chunks no longer appear in any read.
getArtifactChunks0 of 1 parameter describedResolve chunk ids to their document, page, bounding box and text, keyed by chunk id. Chunk ids are the `[chunk_id=…]` markers in `content_with_chunkids_md` and the values workers cite (e.g. `data-cite-chunk`). Ids that are unknown or whose document was deleted are omitted.
getArtifactStatusSummary0 of 1 parameter describedCount the artifacts in a scope, broken down by processing status. Define the scope with bracket notation (e.g. `scope[email_id]=abc-123`). At least one key is required; multiple keys are combined with AND logic.
getArtifactUploadUrl0 of 1 parameter describedReturns a pre-signed PUT URL. Upload the file directly to `upload_url`, then pass `file_url` as `source_url` to POST /v1/upload-file.
updateArtifactMetadata0 of 2 parameters describedMerge-update metadata on an existing artifact. Provided keys are added or overwritten; other existing keys are preserved.
signUp0 of 1 parameter describedCreate a new user account with email and password. When the response includes a pending_authentication_token, the account requires email verification: complete it via sign-in (type: email_otp) with the emailed one-time password and this token.
signIn0 of 1 parameter describedAuthenticate using one of the supported methods: - **Password:** Email and password credentials. If the password is correct but the email is not verified yet, responds 403 with `data.pending_authentication_token` and a fresh verification code is emailed; complete verification via **Email OTP**. Each password attempt invalidates earlier codes and tokens, so always use the most recent pair — repeating the password sign-in is also how a new code is requested. - **OAuth:** Authorization code from OAuth flow (social or enterprise SSO). Pass the `provider` the flow was started with so the code is exchanged against the system that issued it. `verifier` is only required when the flow was started with a `code_challenge` — see **Get OAuth sign-in URL**. - **Email OTP:** One-time password sent to email. Include the `pending_authentication_token` from sign-up, or from the 403 returned by an unverified user's password sign-in, when completing email verification.
requestPasswordReset0 of 1 parameter describedStart password recovery for an email/password account. When the email belongs to an account, a reset link is emailed to it. The response is 200 regardless, and does not reveal whether an account exists.
resetPassword0 of 1 parameter describedComplete password recovery with the token from the emailed reset link and set a new password. Completing the reset also verifies the account's email address. Afterwards, sign in with the new password.
refreshToken0 of 1 parameter describedExchange a valid access token and refresh token pair for new tokens.
refreshSession0 of 1 parameter describedRotate the refresh token and return a new access token for `tenant_id`. Call it with a different `tenant_id` to switch tenants. Send the current access token as `Authorization: Bearer`. It may be expired: it only identifies the user, and the refresh token must belong to that same user. The identity provider decides whether the session is still valid. The user must be a member of `tenant_id` (404 otherwise).
getOAuthUrl0 of 1 parameter describedGenerate an OAuth authorization URL for a given provider. PKCE is optional. To use it, generate a random verifier, derive `code_challenge` from it, and pass both `code_challenge` and the matching `code_challenge_method` — then send the verifier to **Sign in** when exchanging the code. Omit both to run the flow without PKCE and exchange the code on its own. For enterprise SSO, pass `provider=sso` together with the user's `email`; the email domain selects the SSO organization. Responds 404 when no SSO organization is configured for the domain.
getSessionToken0 of 1 parameter describedExchange an identity token for a tenant-scoped Core Plane access token. - If `tenant_id` is provided, validates the user is a member of that tenant and returns 404 if they are not. - If `tenant_id` is omitted, selects the tenant of the identity token's organization, falling back to the user's default (oldest) tenant. - Call this endpoint again with a different `tenant_id` to switch tenants.
getPartnerJwks0 of 1 parameter describedReturns the JSON Web Key Set (RFC 7517) of a partner's public signing keys, used to verify partner-issued launch tokens.
partnerLaunch0 of 1 parameter describedVerifies a partner-signed launch token, mints an Avallon session, and redirects (302) the user into the app's handoff route, carrying the session token in the URL fragment (no cookie).
listCalls0 of 1 parameter describedList all calls, with pagination, filtering, and sorting. **Filtering:** Filter by agent, direction, status, time range, phone number, and more. Phone number filter supports both exact E.164 matches and partial search. **Case Filtering:** Use `case_id` to return only calls linked to a case. This reads the case links created via `POST /v1/cases/{caseId}/links`, and is independent of any `metadata.case_id` a call may carry. **Metadata Filtering:** Use bracket notation to filter by metadata keys: - `metadata[claim_id]=abc-123` - `metadata[source]=worker` Multiple metadata filters can be combined (AND logic).
createCall0 of 1 parameter describedCreate an outbound call for a voice agent, either for later or right away. **Scheduling:** Provide `scheduled_at` (ISO 8601) to place the call later. It is dialed within 60 minutes of that time, or it expires. Omit `scheduled_at` to dial immediately. **Lifecycle:** The call starts as `scheduled` and moves to `in_progress` when it is dialed, then `ended`. A scheduled call can be canceled with `POST /v1/calls/{id}/cancel`. **Environment:** `environment` selects which promoted agent configuration and phone binding the call dispatches against (`live` or `test`). Defaults to `live`.
getCall0 of 2 parameters describedRetrieve detailed information about a specific call. Set `include_messages=true` to include the full message transcript.
cancelCall0 of 1 parameter describedCancel an outbound call that is still `scheduled`. Canceling a call that is already canceled returns it unchanged; a call that is in progress or has ended cannot be canceled.
listenCall0 of 1 parameter describedIssue a short-lived token that joins a connected call as a hidden, listen-only participant. Only calls that are `in_progress` with a `connected_at` can be listened to.
getCallEvaluation0 of 1 parameter describedRetrieve the evaluation results for a specific call, including overall score, pass status, and per-metric breakdowns.
getCallAnalytics0 of 1 parameter describedRetrieve aggregated call analytics for a time range. Includes summary statistics, call volume over time, evaluation scores, score and duration distributions, and per-metric performance.
getAnalyticsTimeSeries0 of 1 parameter describedRetrieve a tenant-scoped time series for a single metric. Pick a `metric`, a date range, a bucket `granularity` (day/week/month), and optionally a `group_by` dimension and filters. The series is sparse (only buckets with data) over the half-open window `[from, to)`. - `worker_runs`, `documents`, `pages`: processing volume, bucketed by creation time. `worker_runs` can be grouped by `worker_id` and filtered by `worker_id` and `environment`. Documents are shared across environments and cannot be filtered by them. - `finished_worker_runs`, `avg_worker_run_duration_ms`, `avg_worker_run_artifacts`, `worker_run_cost_usd`, `avg_worker_run_cost_usd`: worker runs that ended as completed, failed or canceled, windowed and bucketed by completion time. Runs created by worker evals and benchmarks are excluded. These can be filtered by `worker_id` and `environment`. - `finished_worker_runs`: number of finished runs. Can be grouped by `outcome` (`goal_reached`, `goal_not_reached`, `failed`, `canceled`); a completed run without a reported outcome counts as `goal_reached`. - `avg_worker_run_duration_ms`: average time from start to completion, in milliseconds. Runs that never started are excluded. - `avg_worker_run_artifacts`: average number of input artifacts resolved from the run's scope. Runs without a recorded artifact resolution are excluded. - `worker_run_cost_usd`, `avg_worker_run_cost_usd`: total and average estimated LLM cost of the runs, in USD. Canceled runs, runs that never reported the cost of their extraction, and runs that used a model without published pricing are excluded. Requires the `analytics:view-cost` permission. `data` is an array of per-metric results; today it always contains exactly one entry (the requested metric).
createCallFeedback0 of 2 parameters describedCreate feedback for a specific message in a call. Requires user (JWT) authentication; the author is derived from the authenticated user's profile and API-key callers are rejected.
listCallFeedback0 of 2 parameters describedList all feedback for a call. Paginated.
deleteCallFeedback0 of 1 parameter describedDelete a single feedback entry.
checkInboxAvailability0 of 1 parameter describedCheck whether a given email username is available for creating a new inbox. For compatibility this endpoint is also available using the following (deprecated) paths: `GET /v1/email-agents/availability`
createInbox0 of 1 parameter describedCreate a new inbox linked to a processor (extractor or worker). The inbox receives emails at the live address built from `username` and at a test address built from `test_username` (defaults to `<username>-test`), and automatically processes attachments using the specified processor. Either `processor_id` or the deprecated `extractor_id` must be provided. When using `extractor_id`, the processor type defaults to `extractor`. For compatibility this endpoint is also available using the following (deprecated) paths: `POST /v1/email-agents`
listInboxes0 of 1 parameter describedList all inboxes with pagination and sorting. For compatibility this endpoint is also available using the following (deprecated) paths: `GET /v1/email-agents`
updateInbox0 of 2 parameters describedUpdate an inbox's configuration. For compatibility this endpoint is also available using the following (deprecated) paths: `PATCH /v1/email-agents/{id}`
deleteInbox0 of 1 parameter describedDelete an inbox. The inbox stops routing new mail; existing email history is preserved.
getEmail0 of 1 parameter describedRetrieve detailed information about a specific email, including full body content and the artifact IDs of its attachments.
deleteEmail0 of 1 parameter describedSoft-delete an email. The message is hidden from all reads (get, list, and thread aggregation) but its content is retained until a separate hard purge.
listEmails0 of 1 parameter describedList all emails with pagination and filtering. **Filtering:** Filter by email agent, sender, recipient, content search, or case.
listEmailThreads0 of 1 parameter describedList email threads with pagination. Each thread includes the subject of the first email, the sender of the first email, and the date of the last email. **Filtering:** Filter by inbox or environment. Without an `environment` filter, live and test threads are returned together.
replyToEmail0 of 2 parameters describedReply to an existing email thread via Nylas. The reply is sent to the original sender by default. Optionally include additional recipients via `to` (merged with the original sender), `cc`, and `bcc` arrays. The `body` is HTML by default. Set `is_html` to `false` to provide plain text instead; it is converted to HTML before sending.
sendEmail0 of 1 parameter describedSend a new email through an inbox. The provider-assigned thread id is returned and persisted on the stored email row, so subsequent inbound replies on that thread are linked to this send. The `body` is HTML by default. Set `is_html` to `false` to provide plain text instead; it is converted to HTML before sending.
listExtractorJobs0 of 1 parameter describedList all extraction jobs with pagination, filtering, and sorting. **Scope Filtering:** Use bracket notation to filter by scope keys: - `scope[call_id]=abc-123` - `scope[email_id]=xyz-456` - `scope[case_id]=case-789` Multiple scope filters can be combined (AND logic).
createExtractorJob0 of 1 parameter describedCreate a new extraction job for the specified extractor. Provide a non-empty `scope` object to define what the extractor should process (e.g. `{ "claim_id": "abc-123" }`).
getExtractorJob0 of 1 parameter describedRetrieve detailed information about a specific extractor job, including its status, timing, and result.
listWorkerRuns0 of 1 parameter describedList all worker runs with pagination, filtering, and sorting. **Scope Filtering:** Use bracket notation to filter by scope keys: - `scope[call_id]=abc-123` - `scope[email_id]=xyz-456` Multiple scope filters can be combined (AND logic).
createWorkerRun0 of 1 parameter describedCreate a new worker run for the specified worker. Provide a `scope` object with at least one key to define which artifacts the worker should process (e.g. `{ "claim_id": "abc-123" }`). The run stays `pending` until those artifacts are ready. Pass `null` to run the worker without any artifacts — the run is queued immediately. An empty object, or a scope that matches no artifacts, is rejected.
getWorkerRun0 of 1 parameter describedRetrieve detailed information about a specific worker run, including its status, timing, and errors.
listWorkerRunMessages0 of 2 parameters describedRetrieve messages emitted during a worker run, ordered by emission time. Supports cursor-style pagination via `after` and `count`. When a page would exceed the response size limit, the largest messages are replaced by a hint to the full message and marked `truncated`.
getWorkerRunMessage0 of 1 parameter describedRetrieve one message emitted during a worker run, in full. Use it for messages the list endpoint returned with `truncated: true`.
cancelWorkerRun0 of 1 parameter describedCancel a worker run. For in_progress runs, the underlying E2B sandbox is terminated when possible. Pending and queued runs are simply marked canceled. Runs that are starting are still being handed their context and cannot be interrupted, so they cannot be canceled until they reach in_progress. Runs in terminal states (completed, failed) cannot be canceled. Already-canceled runs are returned without side effects.
createWorkerEvalFromRun0 of 2 parameters describedSnapshot a worker run's trigger and resolved artifacts, and record its MCP tool responses from telemetry for replay. Each assertion is graded PASS/FAIL independently on every run.
runEval0 of 2 parameters describedQueue an explicit worker version against the eval's immutable artifact snapshot and mocked tools.
listEvalRuns0 of 2 parameters describedRun history of an eval (newest first by default) without tool traces. Use GET /v1/eval-runs/{evalRunId} for a run's tool trace.
getEvalRun0 of 1 parameter describedGet the status and prompt-grader result for an eval run.
createEvalBenchmark0 of 2 parameters describedQueue runs_per_configuration trials of the eval against a candidate and a baseline worker version. When all trials finish, the benchmark reports mean ± stddev pass rate per configuration, the candidate-minus-baseline delta, and analyzer notes.
listEvalBenchmarks0 of 2 parameters describedBenchmark history of an eval (newest first by default) without per-run details. Use GET /v1/benchmarks/{benchmarkId} for the runs.
getBenchmark0 of 1 parameter describedGet a benchmark with its per-run gradings and metrics, and once all runs finished, the per-configuration summary, delta, and analyzer notes.
listWorkerEvals0 of 2 parameters describedList the evals recorded for a worker, newest first by default. Fixtures and tool mocks are omitted; tool_mock_count gives the number of tool mocks.
createWorkerBenchmarks0 of 2 parameters describedCreate one benchmark per eval of the worker, or per eval in suite or eval_ids when given, each queueing runs_per_configuration trials against the candidate and the baseline version. Poll each benchmark with GET /v1/benchmarks/{benchmarkId}.
listWorkerEvalSuites0 of 1 parameter describedList the suites of a worker's evals with the evals in each.
setWorkerEvalSuite0 of 2 parameters describedMake the suite contain exactly the given evals of the worker; an empty list removes the suite.
createExtractor0 of 1 parameter describedCreate a new extractor with a name and JSON schema defining the extraction output format.
listExtractors0 of 1 parameter describedList all extractors with pagination, filtering, and sorting. Filter by name using the `name` query parameter.
getExtractor0 of 1 parameter describedRetrieve a single extractor by ID, including its schema and version.
updateExtractor0 of 2 parameters describedUpdate an extractor's schema. This creates a new version of the extractor.
deleteExtractor0 of 1 parameter describedSoft-delete an extractor and all of its versions. Soft-deleted extractors no longer appear in any read.
createWorker0 of 1 parameter describedCreate a new worker with a name and prompt.
listWorkers0 of 1 parameter describedList all workers with pagination, filtering, and sorting. Filter by name using the `name` query parameter.
getWorker0 of 1 parameter describedRetrieve a single worker by ID.
deleteWorker0 of 1 parameter describedDelete a worker. The worker is hidden from all reads; its run history is preserved.
updateWorker0 of 2 parameters describedPartially update a worker. Omitted fields are left unchanged, and one request creates at most one new config version.
getWorkerPrompt0 of 2 parameters describedRetrieve the prompt for a worker. Pass `version` to fetch the prompt snapshot at a specific config version; omit it to fetch the current prompt. Internal use only.
updateWorkerPrompt0 of 2 parameters describedUpdate the prompt for a worker. Internal use only. **Deprecated:** Use `PATCH /v1/workers/{workerId}` instead.
listWorkerModelsno parametersList the LLM models that can be assigned to a worker via the `model` field on update.
updateWorkerMcps0 of 2 parameters describedReplace the set of MCP servers a worker connects to. Pass an empty array to disconnect. **Deprecated:** Use `PATCH /v1/workers/{workerId}` instead.
getAccess0 of 1 parameter describedList who an entity is shared with. Admins see every entity through their role, whether or not they are listed. Requires `workers:write` on a worker, `case-types:write` on a case type and `voice-agents:write` on a voice agent.
changeAccess0 of 2 parameters describedGrant, change or revoke access for specific team members and workers. Everyone not named keeps their access. Each grantee must be a team member or a worker of the tenant. Requires `workers:write` on a worker, `case-types:write` on a case type and `voice-agents:write` on a voice agent. An editor who revokes their own grant loses access, and one who downgrades it can no longer change or share the entity, unless their role gives it.
getMyAccess0 of 1 parameter describedList what the caller may do with an entity, through their role or a grant on it, to decide which controls to show. An entity the caller cannot see is not found.
listWorkerVersions0 of 2 parameters describedList all config versions for a worker, ordered by version (newest first by default).
getWorkerVersion0 of 1 parameter describedRetrieve a single worker config version, including the worker's identity, the config snapshot at that version, and version-specific metadata. The prompt is served separately by the worker prompt endpoint.
promoteWorkerVersion0 of 2 parameters describedSelect a worker configuration version for the live or test environment. This freezes the config snapshot only — the E2B template, attached tools and attached secrets are not versioned and always resolve to their current values.
getWorkerVersionChangeSummary0 of 1 parameter describedReturns an AI-generated summary of what changed between this version and the previous one. Initial version returns an empty string since there is no predecessor.
createWorkerWebhook0 of 2 parameters describedCreate a webhook that fires when events occur for the specified worker.
listWorkerWebhooks0 of 2 parameters describedList all webhooks configured for a specific worker.
listCases0 of 1 parameter describedList all cases for the current tenant, paginated, filterable, and sortable.
createCase0 of 1 parameter describedCreate a case with a client-supplied id. Case ids are tenant-scoped opaque keys (e.g. "clm-1", "STD-001") and are normalized server-side (trimmed and lowercased). Creating an id that already exists **in the same environment** returns 409 — the same id can exist once in `live` and once in `test`.
searchCases0 of 1 parameter describedProbe for candidate cases. Matches the query as a normalized substring of the case id, and fuzzily (trigram) against subject and reporter. Results are relevance-ranked — id matches first, then best fuzzy match, then most recently updated — so ordering is fixed and not configurable.
getCase0 of 2 parameters describedRetrieve a case by id, with its current fields. Related entities are not embedded — fetch them via the filtered list endpoints, e.g. `GET /v1/worker-runs?case_id=…` and `GET /v1/artifacts?metadata[case_id]=…`.
deleteCase0 of 2 parameters describedDelete a case. The case and its links stop being visible; the linked entities themselves are untouched. The id becomes available again — a case created with the same id afterwards is a new, empty case, not the deleted one. Unlike removing a case link, this is **not** idempotent: deleting a case that does not exist, or has already been deleted, returns 404.
updateCase0 of 3 parameters describedOnly the fields sent change.
getCaseCitations0 of 2 parameters describedResolve the chunks cited by a case's current field values, keyed by chunk id. Each field in `GET /v1/cases/{id}` lists its citations as chunk ids; this endpoint returns the document, page, bounding box and text for each. Chunks whose document was deleted are omitted. A case with no cited fields returns an empty map.
addCaseLinks0 of 3 parameters describedLink up to 100 entities (artifacts, calls, chats, emails, extracts, information requests, schedules, worker runs) to a case. The case and every entity must already exist in the tenant — unknown ids return 404 and nothing is created. Calls, emails, information requests and worker runs must belong to the case's environment, and a schedule must run in it; artifacts, chats and extracts are not environment-scoped and can be linked to a case in either. A mismatch rejects the whole request. Adding is idempotent: re-linking an already linked entity returns the existing link with its original `created_at`.
listCaseLinks0 of 2 parameters describedList the entities linked to a case, paginated and filterable by entity type.
removeCaseLink0 of 2 parameters describedRemove the link between a case and an entity. Removal is idempotent: removing a link that does not exist succeeds without effect.
createChatAgent0 of 1 parameter describedCreate a new chat agent with a name and prompt.
listChatAgents0 of 1 parameter describedList the tenant's chat agents with pagination and sorting. Prompts are not returned.
getChatAgent0 of 1 parameter describedRetrieve a single chat agent by ID, including the IDs of its attached code tools. The prompt is not returned.
updateChatAgent0 of 2 parameters describedPatch a chat agent's attached code tool set and evaluator. The response does not include the resulting tool list; the agent's `updated_at` is not bumped when only the tool set changes. Set `evaluator_slug` to score the agent's chats with that evaluator when they end. It applies to every chat that ends afterwards.
deleteChatAgent0 of 1 parameter describedSoft-delete a chat agent. The agent no longer appears in any read and stops accepting new chats; existing chats and messages are preserved.
getChatAgentPrompt0 of 1 parameter describedRetrieve the prompt and greeting for a chat agent. Internal use only.
updateChatAgentPrompt0 of 2 parameters describedUpdate the prompt and/or greeting for a chat agent. Internal use only.
createChat0 of 1 parameter describedCreate a new chat against an existing chat agent. The chat agent's tenant becomes the owner of the chat. If the agent requires authentication (`identity_provider_id` on the public chat agent), send the identity token from `POST /public/v1/identity/token` in the `X-External-Identity-Token` header; without a valid token the request fails with 401.
getChat0 of 1 parameter describedReturn a chat and its messages in chronological order. Used to re-render a transcript after a reload. Only `user` and `assistant` messages are included; tool calls and tool results are omitted. Each message's `content` is the concatenation of its text blocks separated by newlines. For compatibility this endpoint is also available using the following (deprecated) paths: `GET /public/v1/chat`
getPublicChatAgent0 of 1 parameter describedReturn the public-facing fields of a chat agent for use in the chat UI. Sensitive fields such as the agent's prompt and tenant ID are not exposed.
postChatMessage0 of 2 parameters describedPost a user message to an existing chat and return the assistant reply. Both messages are persisted. For compatibility this endpoint is also available using the following (deprecated) paths: `POST /public/v1/chat/messages`
endChatno parametersEnd a chat. Further messages are rejected with `409`. Ending an ended chat also returns `204`.
exchangeExternalIdentityToken0 of 1 parameter describedRedeem a single-use interclient token from a partner identity provider for a short-lived Avallon identity token. A malformed request body returns 400. A rejected exchange returns 401; the interclient token may already be spent, so request a fresh one before retrying.
listChats0 of 1 parameter describedList the tenant's chats with pagination, sorting, and optional filtering by case. Returns chat metadata, message counts and evaluation outcome; messages are not included.
listChatMessages0 of 2 parameters describedList messages for a chat owned by the tenant, in chronological order by default.
getChatEvaluation0 of 1 parameter describedRetrieve the evaluation results for a chat, including overall score, pass status, and per-metric breakdowns.
getPublicFormSubmission0 of 2 parameters describedReturn the title and JSON Schema of the form version a submission link is pinned to, for the form renderer. The id and the password set on create are the credential; an unknown id is 404 and a wrong password, or a link created without one, is 401. Once the request has been submitted the request fails with 409 and `{ title }`.
submitFormSubmission0 of 2 parameters describedStore the answers for a submission link and hand them to the form's processor. Each link can be submitted once: a second submit fails with 409. The id and the password set on create are the credential; an unknown id is 404 and a wrong password, or a link created without one, is 401.
getPublicFormSubmissionTheme0 of 1 parameter describedReturn the form title and the name and branding of the tenant a submission link belongs to, so the form renderer can style the page before the password is entered. Needs no password; an unknown id is 404.
createForm0 of 1 parameter describedCreate a form. Its schema becomes version 1, used by both live and test. The schema is validated against the renderer subset; violations are reported as 400 with the offending field path.
listForms0 of 1 parameter describedList the forms shared with the caller, each at its latest version.
getForm0 of 1 parameter describedRetrieve a form at its latest version.
updateForm0 of 2 parameters describedPartially update a form. Omitted fields are left unchanged, and one request creates at most one new version — none when nothing changed. Live and test keep pointing at their versions until promoted.
listFormVersions0 of 2 parameters describedList a form's versions without their schemas, newest first by default. Fetch a version's schema with the form version endpoint.
getFormVersion0 of 1 parameter describedRetrieve a form at the given version, including that version's schema.
promoteFormVersion0 of 2 parameters describedPoint the live or test environment at an existing form version. New submission links for that environment are pinned to it; open links keep their version.
createFormSubmission0 of 1 parameter describedOpen a submission link for a form, pinned to the version the given environment points at. Send the returned url and the password to the person filling the form.
listFormSubmissions0 of 1 parameter describedList the submission links of the forms shared with the caller, with the answers of those already submitted.
getFormSubmission0 of 1 parameter describedRetrieve a submission link and, once it was submitted, the answers. Used by the form's worker and the studio; respondents use the public endpoint instead.
getExtract0 of 1 parameter describedRetrieve a single extract by ID, including the extraction result data.
getExtractCitations0 of 1 parameter describedRetrieve the citation tree with resolved chunk data for a given extract. Returns 404 if the extract does not exist or has no citations (the citations sub-resource is not available).
listExtracts0 of 1 parameter describedList all extracts with pagination, filtering, and sorting. **Scope Filtering:** Use bracket notation to filter by scope keys: - `scope[claim_id]=abc-123` Multiple scope filters can be combined (AND logic).
getProfileno parametersRetrieve the current user's profile information. This endpoint requires a user session and cannot be used with API Keys.
listTeamMembersno parametersList all members in the current tenant.
inviteTeamMember0 of 1 parameter describedInvite an email address to join the current tenant. The invitee receives an email and joins at the `member` role once they accept; promote them afterwards with `PATCH /v1/team/members/{id}`. Requires the `teams:write` permission. Returns `409` if the address already has a pending invitation or is already a member.
listTeamInvitationsno parametersList the invitations for the current tenant that are still awaiting acceptance. Accepted, revoked and expired invitations are not returned. Invitees are not team members yet, so they do not appear in `GET /v1/team/members`. A member-management screen shows both by merging the two lists. Requires the `teams:write` permission.
revokeTeamInvitation0 of 1 parameter describedCancel a pending invitation. The link that was emailed to the invitee stops working, and the address becomes free to invite again. Idempotent: an invitation that was already accepted, revoked or expired also returns `204`. Requires the `teams:write` permission. Returns `404` for an unknown invitation or one that belongs to another tenant.
resendTeamInvitation0 of 1 parameter describedEmail the invitation to its recipient again, for an invite that never arrived. The invitation keeps its `id` and its original expiry — this re-sends the existing link rather than issuing a new one. To give someone a genuinely fresh 5 days, revoke the invitation and send a new one instead. Requires the `teams:write` permission. Returns `409` if the invitation is no longer pending — it was accepted, revoked or expired underneath the caller — and `404` for an unknown invitation or one that belongs to another tenant.
updateMemberRole0 of 2 parameters describedChange the role of a team member.
removeMember0 of 1 parameter describedSoft-delete a team member, revoking access on the next token refresh.
getTenantSettingsno parametersRetrieve the settings of the current tenant.
updateTenantSettings0 of 1 parameter describedUpdate settings of the current tenant. Requires the `tenants:write` permission, which only Avallon admins hold.
createSecret0 of 1 parameter describedCreate an organization-level secret. The value is encrypted at rest and **write-only** — no endpoint ever returns it. Requires the `secrets:write` permission. Env keys used by the worker runtime itself (e.g. `OPENAI_API_KEY`, `AVALLON_*`, `AWS_*`) are reserved and rejected.
listSecrets0 of 1 parameter describedList the organization's secrets with pagination and sorting. Values are never included. Requires the `secrets:read` permission.
getSecret0 of 1 parameter describedGet a secret's metadata. The value is never included. Requires the `secrets:read` permission.
updateSecret0 of 2 parameters describedUpdate a secret's display name or description, or rotate its live or test value. Rotation overwrites the stored value — previous values are not retrievable. The `env_key` is immutable: consumers of the secret receive the value under that key, so changing it would silently break them. Create a new secret instead. Requires the `secrets:write` permission.
deleteSecret0 of 1 parameter describedDelete a secret and detach it from all entities. Requires the `secrets:write` permission.
createEvaluator0 of 1 parameter describedCreate an evaluator: a named set of metrics that an LLM judge scores every call or chat of the agents it is attached to. Evaluators can't be changed after creation, so past scores keep their meaning. To change the criteria, create a new evaluator (e.g. `support-quality-v2`) and attach that instead. A slug that already exists returns 409. Attach it to a voice agent with `PATCH /v1/voice-agents/{voiceAgentId}` (`evaluator_slug`), then promote that version, or to a chat agent with `PATCH /v1/chat-agents/{chatAgentId}` (`evaluator_slug`). Requires the `evaluators:write` permission.
listEvaluatorsno parametersList all evaluators of the tenant with their metrics.
getEvaluator0 of 1 parameter describedRetrieve an evaluator and the metrics its judge scores.
createSchedule0 of 1 parameter describedCreate a schedule that performs an action, either repeatedly or once. `action` describes **what** happens: `trigger_worker` starts a worker run with the given scope, and `execute_tool` executes a tool without parameters. `rule` describes **when**: `recurring` carries one or more `patterns`, and fires whenever any of them comes round. A pattern fires every hour at `minute`, narrowed by `hours` and `weekdays` — so `hours: [9]` is daily at 09:00, `hours: [12], weekdays: [1]` is Mondays at noon, and `hours: [9, 13, 17], weekdays: [1, 2, 3, 4, 5]` is three times a day on weekdays. Give a second pattern to mix cadences: hourly on weekdays plus 09:00, 11:00 and 18:00 at weekends is two patterns on one schedule. Patterns overlap harmlessly — two that land on the same minute fire once. Every set is read in the schedule's own time zone — an IANA identifier such as `America/Chicago`, resolved across DST transitions. `once` fires a single time at a UTC instant. `environments` says **which version** of the worker or tool each occurrence runs: `live` resolves it at its live version, `test` at its test version. Give both to soak a candidate version on the same cadence as production — every occurrence then fires twice, once per environment. Omit it to fire in `live` only. The response's `next_run_at` is the first occurrence strictly after the moment of creation; a rule that resolves to no such occurrence is rejected. Create with `enabled: false` to stage a recurring schedule without letting it fire. A one-off is always enabled: delete it to cancel it, and its `next_run_at` becomes null once it has fired. Requires the `schedules:write` permission, and `tools:execute` for an `execute_tool` action.
listSchedules0 of 1 parameter describedList the organization's schedules. Requires the `schedules:read` permission.
getSchedule0 of 1 parameter describedRetrieve a single schedule. Requires the `schedules:read` permission.
updateSchedule0 of 2 parameters describedUpdate a schedule's rule, environments, name, or enabled state. Changing the rule moves `next_run_at` to the first occurrence after the update; a rule that resolves to no such occurrence is rejected. One-off schedules are always enabled — delete one to cancel it before it fires. `environments` replaces the whole list rather than adding to it. It takes effect from the next occurrence: one already due keeps the environments it was created with.
deleteSchedule0 of 1 parameter describedDelete a schedule so it stops firing.
listDispatches0 of 1 parameter describedList the organization's dispatches, newest occurrence first. A dispatch is one occurrence of a trigger in one environment, carried out on its own: a schedule produces one per environment it runs in every time it fires, an inbound email produces one for the environment its inbox received it in, a resolved information request produces one that restarts the worker that asked, an ended call produces one that runs its voice agent's post-call processor once its transcript is ready, and creating a worker run through the API produces a `manual` one, carried out before the request returns. Listing them shows what a trigger has actually done, including occurrences that never produced anything. - `pending` — not carried out yet: waiting to be picked up, in flight, or waiting on a retry after an earlier pickup did not complete. - `dispatched` — carried out. - `abandoned` — gave up, because the occurrence passed its `expires_at` deadline before it could be carried out, or, for a `manual` dispatch, because the request that created it failed. `attempts` counts how many times the occurrence has been picked up, not how many times it failed: a dispatch carried out on the first pickup ends at `attempts: 1`, and a higher count means earlier pickups did not complete. `target` is what the occurrence produced: a worker run, an extractor job (for an email whose inbox extracts or a call whose voice agent extracts), or a tool call (for an `execute_tool` schedule). It is null until the dispatch is carried out, and for a tool call until the tool has run. Narrow to one trigger with `trigger_type` and `trigger_id` — the schedule's ID for a schedule, the email's ID for an email, the request's ID for an information request, the call's ID for a call. `trigger_id` requires `trigger_type`.
listNotifications0 of 1 parameter describedList the organization's notifications, newest first. A notification is a durable record that something happened and that somebody should know about it. Notifications are not yet addressed to individual people, so everyone in the organization sees the same feed. `title` and `body` are the display text — render them as-is rather than deriving your own wording from `type`, so every surface says the same thing. `data` carries the identifiers the notification points at, so a client can link to the thing it is about; which keys are present depends on `type`. `worker_issue_reported` means a worker hit a problem during a run and reported it; its `body` is the worker's own message and its `data` is the reporting `worker_id` and `run_id`. `information_request_created` means a worker paused to ask a person a question; its `data` is the `request_id` to answer through `POST /v1/information-requests/{informationRequestId}/resolve`.
getNotification0 of 1 parameter describedRetrieve a single notification by its ID, the id a `notification.created` webhook delivery carries. `title` and `body` are the display text — render them as-is rather than deriving your own wording from `type`, so every surface says the same thing. `data` carries the identifiers the notification points at, so a client can link to the thing it is about; which keys are present depends on `type`. `worker_issue_reported` means a worker hit a problem during a run and reported it; its `body` is the worker's own message and its `data` is the reporting `worker_id` and `run_id`. `information_request_created` means a worker paused to ask a person a question; its `data` is the `request_id` to answer through `POST /v1/information-requests/{informationRequestId}/resolve`.
createInformationRequest0 of 1 parameter describedAsk a person for a specific fact you cannot establish yourself. Use this when one missing piece of information is blocking you and only a human can supply it — which claim a document belongs to, which of two policies applies, what an ambiguous reference means. Ask one answerable question per request, and write it so it stands on its own: whoever resolves it sees your title and your question and nothing else. Immediately link the request to its case with `addCaseLinks` and `entity_type: "information_request"`. That is how it reaches the person working that case; unlinked, it sits in a queue nobody is looking at. Leave it unlinked only when you genuinely cannot tell which case it belongs to. **This does not block or suspend you.** Nobody resolves it while this run is happening. Carry on with what you can still do, or stop, and say in your final report that you asked. Do not use it for progress updates, or for anything you can work out yourself.
listInformationRequests0 of 1 parameter describedList the organization's information requests, newest first. An information request is a specific question a worker could not settle on its own and needs a person to resolve. It stays open until somebody resolves it; there is no separate status field.
getInformationRequest0 of 1 parameter describedRetrieve a single information request by its ID.
deleteInformationRequest0 of 1 parameter describedDelete an information request, open or resolved..
resolveInformationRequest0 of 2 parameters describedResolve an open information request by providing an answer/resolution.
createCaseType0 of 1 parameter describedCreate a case type. Its fields become version 1, used by both live and test.
listCaseTypes0 of 1 parameter describedList the organization's case types, without their fields.
getCaseType0 of 1 parameter describedRetrieve a case type with its fields at the newest version. Inside a worker run, returns the version the run's environment points at.
updateCaseType0 of 2 parameters describedUpdate a case type. Its fields are changed through `/v1/case-types/{caseTypeSlug}/fields`.
listCaseTypeVersions0 of 2 parameters describedList a case type's versions, newest first by default.
getCaseTypeVersion0 of 1 parameter describedRetrieve a case type with its fields at a specific version.
promoteCaseTypeVersion0 of 2 parameters describedPoint the live or test environment at a version. Any existing version can be promoted, including an older one.
createCaseTypeField0 of 2 parameters describedAdd a field to a case type. Creates a new version; promote it to use the field.
updateCaseTypeField0 of 2 parameters describedChange a field's label, description, nullability, enum or sensitivity. Creates a new version when something changes; promote it to use the change. A field's key, type, list-ness and parent are permanent.
deleteCaseTypeField0 of 1 parameter describedRemove a field from a case type. Creates a new version; once it is promoted, the field can't be written. Deleting an object deletes its fields with it. Cases keep their values, and the key can't be reused.
createTool0 of 1 parameter describedCreate a new code tool that can be attached to agents. Provide the tool's name, code, and description.
listTools0 of 1 parameter describedList all code tools with sorting. For compatibility this endpoint is also available using the following (deprecated) paths: `GET /worker/v1/tools`
deleteTool0 of 1 parameter describedDelete a tool. Fails with a conflict when the tool is still attached to a voice agent, worker, or chat agent; detach it first.
getTool0 of 1 parameter describedRetrieve a single tool by ID at its newest config version, including its code, schema, description and attached secrets, plus the versions each environment runs. For compatibility this endpoint is also available using the following (deprecated) paths: `GET /worker/v1/tools/{id}`
updateTool0 of 2 parameters describedUpdate a code tool's name, description, code, or attached secrets. All fields are optional — only provided fields are updated. Changing the code, description or attached secrets creates a new config version; runs keep executing the versions promoted to live and test until that version is promoted. Renaming does not create a version.
executeCode0 of 2 parameters describedExecute a code tool with the given parameters. Returns the result, any errors, and execution traces. For compatibility this endpoint is also available using the following (deprecated) paths: `POST /worker/v1/tools/{id}/execute`
listToolVersions0 of 2 parameters describedList all config versions for a tool, ordered by version (newest first by default).
getToolVersion0 of 1 parameter describedRetrieve a single tool config version: the tool's identity, the code, schema, description and attached secrets at that version, and version metadata.
promoteToolVersion0 of 2 parameters describedSelect a tool config version for the live or test environment. Runs in that environment execute this version's code with this version's schema and attached secrets from then on.
getToolVersionChangeSummary0 of 1 parameter describedReturns an AI-generated summary of what changed between this version and the previous one. Initial version returns an empty string since there is no predecessor.
listToolCalls0 of 1 parameter describedList tool calls without their params, result, error and traces. Requires the `tool-calls:read` permission.
getToolCall0 of 1 parameter describedRetrieve a single tool call. Requires the `tool-calls:read` permission.
workerListTools0 of 1 parameter describedList all code tools with sorting.
workerGetTool0 of 1 parameter describedRetrieve a single tool by ID at its newest config version, including its code, schema, description and attached secrets, plus the versions each environment runs.
workerExecuteTool0 of 2 parameters describedExecute a code tool with the given parameters. Returns the result, any errors, and execution traces.
notifyAdmin0 of 1 parameter describedReport a problem to the people who run this organization. Use this for something a human has to resolve — a login that no longer works, a document you cannot read, a system that will not let you in, instructions that contradict what you found. The report goes to the organization's notifications; nobody sees it while the run is happening, so it does not unblock you now. Carry on with what you can still do, or stop, and say in your final report that you raised it. Do not use it for progress updates or for anything you can work around yourself.
uploadFile0 of 1 parameter describedUpload a file for processing by passing a URL to a file. Use this for uploading larger files. This endpoint returns an upload id that can be used to find the created artifacts using the list artifacts endpoint.
createAgentWebhook0 of 2 parameters describedCreate a webhook that fires when events occur for the specified voice agent. For compatibility this endpoint is also available using the following (deprecated) paths: `POST /v1/agents/{id}/webhooks`
listAgentWebhooks0 of 2 parameters describedList all webhooks configured for a specific voice agent. For compatibility this endpoint is also available using the following (deprecated) paths: `GET /v1/agents/{id}/webhooks`
createInboxWebhook0 of 2 parameters describedCreate a webhook that fires when events occur for the specified inbox. For compatibility this endpoint is also available using the following (deprecated) paths: `POST /v1/email-agents/{id}/webhooks`
listInboxWebhooks0 of 2 parameters describedList all webhooks configured for a specific inbox. For compatibility this endpoint is also available using the following (deprecated) paths: `GET /v1/email-agents/{id}/webhooks`
createExtractorWebhook0 of 2 parameters describedCreate a webhook that fires when extraction events occur for the specified extractor.
listWebhooks0 of 2 parameters describedList all webhooks configured for a specific extractor.
createNotificationWebhook0 of 1 parameter describedCreate a webhook that fires whenever a notification is raised for the organization. Notifications belong to the organization rather than to a resource, so this webhook is not attached to anything: its `scope` is `{ "notifications": true }` and it receives every notification the organization raises. Each delivery carries the notification's `title` and `body` — the same display text `GET /v1/notifications` returns — alongside the structured `data` it points at. Notifications are not environment-specific, so every delivery is `live`. A webhook that names only `test` receives nothing.
listNotificationWebhooks0 of 1 parameter describedList the webhooks that receive the organization's notifications.
deleteWebhook0 of 1 parameter describedPermanently delete a webhook. This action is irreversible.
getWebhook0 of 1 parameter describedRetrieve a single webhook by ID. The authentication header value is never exposed — only `has_auth` indicates whether authentication is configured.
updateWebhook0 of 2 parameters describedUpdate a webhook's name, destination, environments, enabled state, or authentication. Omitted fields are left unchanged, and at least one must be provided.
listWebhookDeliveries0 of 2 parameters describedList delivery attempts for a specific webhook, with pagination and sorting. Useful for debugging webhook issues.
testWebhook0 of 2 parameters describedSend a test event to a webhook endpoint. Returns the HTTP status code, response time, and any errors. The request is rejected with a 400 if the webhook does not target the given environment, since a successful ping would say nothing about events it will never receive.
Tested in a sandbox with an empty environment: no API keys, a throwaway folder, nothing from a real account. A passing test shows the server runs and responds. It is not a security audit.