Telehealth support for Claude, Codex and Cursor: investigate cases and connect your tools.
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Read the person's Summer access request. Approval is a separate Summer team decision.
This tool takes no arguments.
Tool list last changed Oct 23, 2026.
Read the person's Summer access request. Approval is a separate Summer team decision.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {},
"additionalProperties": false
}Submit or update a Summer access request. This cannot approve access.
| Argument | Type | Description |
|---|---|---|
| note* | string | |
| company_name* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company_name",
"note"
],
"properties": {
"note": {
"type": "string",
"maxLength": 2000
},
"company_name": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}List companies the person can access and whether this connection includes each one.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {},
"additionalProperties": false
}List this person's agent connections, grants, last use and expiry.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {},
"additionalProperties": false
}Revoke one of this person's agent connections immediately.
| Argument | Type | Description |
|---|---|---|
| reason | string | |
| connection* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"connection"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 200
},
"connection": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Show the signed-in person, Summer access status, profile photo path and this connection's grant.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {},
"additionalProperties": false
}Remove your own profile photo. Replies you send afterward show your initials; earlier replies keep the photo they were sent with.
| Argument | Type | Description |
|---|---|---|
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Approve the exact prepared execution under the authenticated operator's delegated authority. Use only for work the operator authorized, read the prepared review first, and pass its exact hash. Records the authorization and queues ordinary execution; approval does not prove a customer outcome. No caller-supplied approver identity or identity-verification attestation.
| Argument | Type | Description |
|---|---|---|
| case* | string | |
| company* | string | Summer company ID |
| execution* | string | |
| environment* | string | Environment that owns the resource |
| approval_hash* | string | |
| authorization* | string | The operator's instruction authorizing this exact work, retained in the approval audit. This is context, not an identity attestation. |
| idempotency_key | string | Reuse the same key when retrying the same change |
Prepare the exact current plan and return its execution ID, approval hash and reviewed work. Does not approve or execute. A delegated actions.approve grant can approve authorized work through API, CLI or MCP.
| Argument | Type | Description |
|---|---|---|
| case* | string | |
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
| idempotency_key | string | Reuse the same key when retrying the same change |
| plan_request_id* | string | |
| replaces_execution | string | Replace an unapproved, unstarted queued execution whose source or selected plan changed. Existing approvals and uncertain work cannot be replaced. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"case",
"plan_request_id"
],
"properties": {
"case": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"plan_request_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"replaces_execution": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Replace an unapproved, unstarted queued execution whose source or selected plan changed. Existing approvals and uncertain work cannot be replaced."
}
},
"additionalProperties": false
}Read the company's sender exclusions and original edit history. Changes retain human approval.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| environment* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
}
},
"additionalProperties": false
}Edit guide media captions, alt text, provenance, transcript or poster at the expected version, or retire unused media. Published releases keep their pinned metadata.
| Argument | Type | Description |
|---|---|---|
| asset* | string | |
| reason* | string | |
| caption* | string | |
| company* | string | Summer company ID |
| retired | boolean | |
| alt_text* | string | |
| provenance* | string | |
| transcript | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
| poster_asset_id |
Read one guide asset, checksum and resumable chunk receipts. No secret upload capability is returned.
| Argument | Type | Description |
|---|---|---|
| asset* | string | |
| company* | string | Summer company ID |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"asset"
],
"properties": {
"asset": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
}
},
"additionalProperties": false
}List the company's private guide media, metadata and upload status. Uploading does not make a file public.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
}
},
"additionalProperties": false
}Verify the original size, content signature and SHA-256 against saved private bytes, then mark a guide upload ready. A ready file remains private until published in a guide.
| Argument | Type | Description |
|---|---|---|
| asset* | string | |
| company* | string | Summer company ID |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"asset"
],
"properties": {
"asset": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Start or recover a private resumable Markdown, image, video, PDF or caption upload from metadata. File bytes are transferred separately; this hosted endpoint has no local filesystem access.
| Argument | Type | Description |
|---|---|---|
| id* | string | |
| sha256* | string | |
| caption* | string | |
| company* | string | Summer company ID |
| alt_text* | string | |
| filename* | string | |
| media_type* | string | |
| provenance* | string | |
| transcript | string | |
Read one capability, its concrete test, evidence and latest 20 review records.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| capability* | string | |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"capability"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"capability": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{1,79}$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}Read the same operational capability checklist, results, discovery paths and review history shown in Summer. Every usable API, browser or knowledge path can count.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}Record the setup agent's capability assessment with original evidence and the path Summer can discover and use. A pass needs evidence and a discovery path. Reports are labeled as agent-reported, never human approval or independently verified execution.
| Argument | Type | Description |
|---|---|---|
| notes* | string | |
| state* | string | |
| company* | string | Summer company ID |
| evidence* | string | |
| capability* | string | |
| environment* | string | Environment that owns the resource |
| fulfillment | object | |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version |
Edit a capability expectation or add a business-specific custom_ capability with a reason. Resets its result and retains history. Does not create a provider tool or grant execution access.
| Argument | Type | Description |
|---|---|---|
| notes* | string | |
| company* | string | Summer company ID |
| capability* | string | |
| definition* | object | |
| environment* | string | Environment that owns the resource |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer | Current version you expect; 0 when the resource does not exist yet |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"capability",
"expected_version",
"definition",
"notes"
],
"properties": {
"notes": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"capability": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{1,79}$"
},
"definition": {
"type": "object",
"required": [
"id",
"title",
"group",
"mode",
"expectation",
"test",
"examples"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{1,79}$"
},
"mode": {
"enum": [
"read",
"approval"
],
"type": "string"
},
"test": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"group": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"title": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"examples": {
"type": "string",
"maxLength": 300
},
"expectation": {
"type": "string",
"maxLength": 700,
"minLength": 1
}
},
"additionalProperties": false
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Current version you expect; 0 when the resource does not exist yet"
}
},
"additionalProperties": false
}Request a read-only Summer capability test on an authorized sample case. Also needs investigations.request and current runtime access. Does not approve or execute customer changes.
| Argument | Type | Description |
|---|---|---|
| case_id* | string | |
| company* | string | Summer company ID |
| capability* | string | |
| environment* | string | Environment that owns the resource |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer | Current version you expect; 0 when the resource does not exist yet |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"capability",
"expected_version",
"case_id"
],
"properties": {
"case_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"capability": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{1,79}$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Current version you expect; 0 when the resource does not exist yet"
}
},
"additionalProperties": false
}Read a case's issue owner, plan reviewer and eligible teammates.
| Argument | Type | Description |
|---|---|---|
| case* | string | |
| company* | string | |
| environment* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"case"
],
"properties": {
"case": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
}
},
"additionalProperties": false
}Assign an issue owner or plan reviewer with the previous owner as a conflict check. Does not grant roles or approve a plan.
| Argument | Type | Description |
|---|---|---|
| case* | string | |
| company* | string | |
| memberId* | any | |
| previous* | any | |
| requestId* | any | |
| environment* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"case",
"requestId",
"memberId",
"previous"
],
"properties": {
"case": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"memberId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"previous": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"requestId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Get a short-lived download for an attachment that belongs to this case.
| Argument | Type | Description |
|---|---|---|
| case* | string | |
| company* | string | Summer company ID |
| attachment* | string | |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"case",
"attachment"
],
"properties": {
"case": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"attachment": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}Read the case customer's profile: name, date of birth, contact details, default shipping and billing addresses, each order's addresses and earlier addresses. A saved address does not prove where an existing order ships.
| Argument | Type | Description |
|---|---|---|
| case* | string | |
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"case"
],
"properties": {
"case": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}Read one case or conversation with its original messages and related records. Operational records include workspace with the current customer ticket and all owned issue references, plus the shared saved timeline. The original case identity is retained. Includes conversationSentiment with happy, neutral, upset, angry, sad, mixed or unknown, confidence, exact evidence references, source, assessed_at and pending freshness; an estimate does not prove resolution.
| Argument | Type | Description |
|---|---|---|
| case* | string | |
| after | integer | |
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"case"
],
"properties": {
"case": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"after": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}List company-owned cases or conversations with emotion filters (sentiment: happy, neutral, upset, angry, sad, mixed or unknown), ordering, page size, coverage and a cursor. Operational rows include conversationSentiment (label, confidence, evidence references, source, assessed_at and pending freshness). Operational filters require the company's operational connection; Messenger-only results include coverage limits.
| Argument | Type | Description |
|---|---|---|
| lane | string | |
| mine | any | |
| plan | string | |
| sort | string | |
| limit | integer | |
| cursor | string | |
| status | string | |
| company* | string | Summer company ID |
| pastSla | any | |
| sandbox | any |
Find cases by customer name, email, phone, date of birth, support code, order or tracking number, vendor or Stripe ID, or message words, with status and date filters. Returns one current workspace per verified customer (explicit splits stay separate), with the actual ticket code, all issue references, plan and run progress, orders and message excerpts. Message case_id opens the workspace; source_case_id retains the original issue. Search matches are leads, not proof of identity or completed work.
| Argument | Type | Description |
|---|---|---|
| q | string | Customer name, email, phone, support code, order or tracking number, Stripe, MDI, Beluga or GEN ID, or care session ID. With messages=true, also words in customer and team messages. |
| dob | string | Exact date of birth, YYYY-MM-DD. With q, keeps only customers that match both. |
| limit | integer | Default 25 |
| status | string | Default all |
| company* | string | Summer company ID |
| messages | any | Also search message text for q. Needs q. |
| environment* | string | Environment that owns the resource |
Check live Summer MCP/API versions, old client warnings and the seven-day discovery refresh interval. Optional cached client versions and the last successful check timestamp distinguish known and unknown status.
| Argument | Type | Description |
|---|---|---|
| cli_version | string | |
| mcp_version | string | |
| last_checked_at | string | ISO 8601 time with an offset, for example 2026-10-01T00:00:00Z |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"cli_version": {
"type": "string",
"pattern": "^\\d+\\.\\d+\\.\\d+$"
},
"mcp_version": {
"type": "string",
"pattern": "^\\d+\\.\\d+\\.\\d+$"
},
"last_checked_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "ISO 8601 time with an offset, for example 2026-10-01T00:00:00Z"
}
},
"additionalProperties": false
}What this connection can do here, with a reason for everything unavailable.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}Read company-wide settings, including the email subject customers see on new support emails. Changes affect every environment.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
}
},
"additionalProperties": false
}Update company-wide settings with the expected version. Affects every environment.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| note* | string | |
| company* | string | Summer company ID |
| timezone* | string | |
| workflow* | string | |
| email_subject | string | Subject customers see on a new support email, such as "Your Example Co support request". Replies to a customer's email keep their subject. Leave out to keep the saved subject; an empty string clears it. |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer | Current version you expect; 0 when the resource does not exist yet |
Saved, verified, pending, unavailable and enabled state for each setup item.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}List company members and pending invitations. Role changes and invitations stay in Summer.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
}
},
"additionalProperties": false
}List saved credential names, sources and versions. Never returns values.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}Save one selected credential value or Doppler reference. Replacing an active credential needs credentials.replace. Returns metadata only. Returns a local CLI command when a secret is involved.
| Argument | Type | Description |
|---|---|---|
| name* | string | Credential variable name, for example STRIPE_READ_KEY |
| source* | string | doppler saves a reference; local_value returns a CLI handoff |
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
| secret_name | string | Doppler secret name, for source=doppler |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"name",
"source",
"expected_version"
],
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Z][A-Z0-9_]{0,127}$",
"description": "Credential variable name, for example STRIPE_READ_KEY"
},
"source": {
"enum": [
"doppler",
"local_value"
],
"type": "string",
"description": "doppler saves a reference; local_value returns a CLI handoff"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"secret_name": {
"type": "string",
"pattern": "^[A-Z][A-Z0-9_]{0,127}$",
"description": "Doppler secret name, for source=doppler"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}Read configuration and activity events after a cursor. Pagination uses next_cursor.
| Argument | Type | Description |
|---|---|---|
| after | string | |
| limit | integer | |
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"after": {
"type": "string",
"pattern": "^\\d{1,18}$"
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}Disconnect this company/environment GitHub source access and remove its cached archives.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| environment* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"expected_version"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}Read the company GitHub installation, selected repositories/folders and cached commit status. Makes no GitHub request and returns no credentials.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| environment* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
}
},
"additionalProperties": false
}Get the Summer browser URL for a company administrator to install and authorize the read-only GitHub App. Does not grant access or connect an installation by itself.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| environment* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
}
},
"additionalProperties": false
}Browse repository folders at a branch or commit before selecting access.
| Argument | Type | Description |
|---|---|---|
| ref* | string | |
| path | string | |
| company* | string | |
| repository* | string | |
| environment* | string | |
| repositoryId* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"repositoryId",
"repository",
"ref"
],
"properties": {
"ref": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"path": {
"type": "string",
"maxLength": 1000
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
},
"repositoryId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
}List repositories available to this company GitHub installation. Provider metadata read; no file content.
| Argument | Type | Description |
|---|---|---|
| page | integer | |
| company* | string | |
| environment* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"page": {
"type": "integer",
"maximum": 10000,
"minimum": 1
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
}
},
"additionalProperties": false
}List cached source paths, or read one cached file with path. Only currently selected company folders are available. No live GitHub call or credentials.
| Argument | Type | Description |
|---|---|---|
| path | string | |
| offset | integer | |
| company* | string | |
| source_id* | string | |
| environment* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"source_id"
],
"properties": {
"path": {
"type": "string",
"maxLength": 1000
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"source_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
}
},
"additionalProperties": false
}Choose repository branches/commits and allowed folders. A dot selects the whole repository. Replaces selections with an expected version and invalidates old cached access. Does not sync code.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| sources* | array | |
| environment* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"expected_version",
"sources"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"sources": {
"type": "array",
"items": {
"type": "object",
"required": [
"repositoryId",
"repository",
"ref",
"folders"
],
"properties": {
"ref": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"folders": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"maxItems": 100,
"minItems": 1
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"repositoryId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"maxItems": 20
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}Refresh the selected repository code cache once from GitHub. Reuses the cache for an unchanged commit; sandbox startup never pulls GitHub.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| source_id* | string | |
| environment* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"source_id"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"source_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Read an editable guide article and its current knowledge revision.
| Argument | Type | Description |
|---|---|---|
| article* | string | |
| company* | string | Summer company ID |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"article"
],
"properties": {
"article": {
"type": "string",
"pattern": "^[a-z0-9]+(?:[.-][a-z0-9]+)*$",
"maxLength": 100
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
}
},
"additionalProperties": false
}Create or edit a Markdown customer article with source references and managed asset IDs. Saves a draft in the shared knowledge library; later edits do not change a published release.
| Argument | Type | Description |
|---|---|---|
| slug* | string | |
| title* | string | |
| topic* | string | |
| reason* | string | |
| article* | string | |
| company* | string | Summer company ID |
| content* | string | |
| summary* | string | |
| asset_ids* | array | |
Read the company's reviewed guide-authoring brief, draft article references and publication state. This read starts no model run and changes no customer data.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
}
},
"additionalProperties": false
}Read the company's editable guidebook, draft articles, assets and publication state. Customer guides share the existing company knowledge source.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
}
},
"additionalProperties": false
}Read the company's guide edits, upload and publication history.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
}
},
"additionalProperties": false
}Read the optional custom guide domain, DNS instructions and verified HTTPS status. Summer-hosted guide URLs need no customer DNS setup.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
}
},
"additionalProperties": false
}Save or remove a custom guide hostname at the expected version. Saving a name does not verify ownership or provision HTTPS.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| hostname* | any | |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"expected_version",
"hostname"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"hostname": {
"anyOf": [
{
"type": "string",
"pattern": "^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z][a-z0-9-]{1,62}$"
},
{
"type": "null"
}
]
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}Check the saved domain's DNS ownership, attach it through Summer's hosting connection and verify HTTPS. Returns pending until each check succeeds.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"expected_version"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}Read the exact current draft, article revisions and authenticated preview URL before publishing. No public access token is issued.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
}
},
"additionalProperties": false
}Publish the exact selected article revisions and ready media to the company's customer help center. Requires explicit publication authority; does not approve customer business actions.
| Argument | Type | Description |
|---|---|---|
| reason* | string | |
| company* | string | Summer company ID |
| articles* | array | |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"expected_version",
"articles",
"reason"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"articles": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"revision"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9]+(?:[.-][a-z0-9]+)*$",
"maxLength": 100
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"maxItems": 200,
"minItems": 1
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}Create or edit guidebook details at the expected version. Saves a private draft; does not publish.
| Argument | Type | Description |
|---|---|---|
| reason* | string | |
| company* | string | Summer company ID |
| settings* | object | |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"expected_version",
"settings",
"reason"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"settings": {
"type": "object",
"required": [
"slug",
"title",
"description",
"accent",
"portal_url"
],
"properties": {
"slug": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 100
},
"title": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"accent": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"portal_url": {
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "uri",
"maxLength": 1000
}
]
},
"description": {
"type": "string",
"maxLength": 1000
},
"logo_asset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"hero_background": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
}
},
"additionalProperties": false
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}Remove the company's guide and release media from Summer's public serving path at the expected version. Downloaded copies cannot be recalled.
| Argument | Type | Description |
|---|---|---|
| reason* | string | |
| company* | string | Summer company ID |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"expected_version",
"reason"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}Read work that Summer agents or blocked approvals asked a person to do, with owners, due times, recorded outcomes and change history for one selected task.
| Argument | Type | Description |
|---|---|---|
| case | string | |
| mine | any | |
| task | string | |
| status | string | |
| company* | string | |
| environment* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"case": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"mine": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"true",
"false"
],
"type": "string"
}
]
},
"task": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"status": {
"enum": [
"open",
"done",
"dismissed",
"all"
],
"type": "string"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
}
},
"additionalProperties": false
}Complete, dismiss, reopen or assign a human task with its expected version. Records the person and outcome. Does not approve a plan or change customer records.
| Argument | Type | Description |
|---|---|---|
| taskId* | string | |
| company* | string | |
| outcome | string | |
| version* | integer | |
| operation* | string | |
| assigneeId | any | |
| environment* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"taskId",
"version",
"operation"
],
"properties": {
"taskId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"outcome": {
"type": "string",
"maxLength": 1000
},
"version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
"operation": {
"enum": [
"complete",
"dismiss",
"reopen",
"assign"
],
"type": "string"
},
"assigneeId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Start, pause, resume or rescan an Intercom migration with its current version. Optional incremental sync reconciles the same original IDs; no replies, notifications or agent runs. Names/email never verify an account.
| Argument | Type | Description |
|---|---|---|
| action* | string | |
| import* | string | |
| company* | string | |
| keep_sync | boolean | |
| environment* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"import",
"expected_version",
"action"
],
"properties": {
"action": {
"enum": [
"start",
"pause",
"resume",
"rescan"
],
"type": "string"
},
"import": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"keep_sync": {
"type": "boolean",
"default": false
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
}Read Intercom migration previews, saved progress, counts, errors and Summer inbox destinations. Does not start an import.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| environment* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
}
},
"additionalProperties": false
}Check the saved Intercom key against a workspace and preview contact/conversation counts. Save the selected Summer inbox and explicit account-matching choice. Import nothing; send nothing.
| Argument | Type | Description |
|---|---|---|
| region | string | |
| company* | string | |
| workspace* | string | |
| environment* | string | |
| installation* | string | |
| match_accounts | boolean | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"installation",
"workspace"
],
"properties": {
"region": {
"enum": [
"us",
"eu",
"au"
],
"type": "string",
"default": "us"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspace": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]+$",
"maxLength": 100,
"minLength": 1
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
},
"installation": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"match_accounts": {
"type": "boolean",
"default": false
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Search imported Summer profiles and their original conversation references. Contact details do not establish account ownership.
| Argument | Type | Description |
|---|---|---|
| q | string | |
| offset | integer | |
| company* | string | |
| workspace* | string | |
| environment* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"workspace"
],
"properties": {
"q": {
"type": "string",
"maxLength": 200
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspace": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
}
},
"additionalProperties": false
}List provider integrations, their categories, required fields, alternative credential sets and saved metadata. Filter by search, category or connection. Connected means all required credentials and one complete alternative set are available, not a live provider check. read_only integrations are read with the company's own key and never written through. Never returns values.
| Argument | Type | Description |
|---|---|---|
| search | string | |
| company* | string | Summer company ID |
| category | string | |
| connection | string | |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"search": {
"type": "string",
"maxLength": 200
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"category": {
"enum": [
"clinical",
"messaging",
"helpdesk",
"orders",
"shipping",
"billing",
"marketing",
"data",
"custom"
],
"type": "string"
},
"connection": {
"enum": [
"connected",
"not_connected"
],
"type": "string"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}Save a custom integration's description, setup instructions and credential field names. This saves metadata only, without credential values or a live connection check.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| fields* | array | |
| company* | string | Summer company ID |
| description | string | |
| environment* | string | Environment that owns the resource |
| integration* | string | |
| instructions | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer | Current version you expect; 0 when the resource does not exist yet |
Prepare an integration-specific MCP setup prompt and Codex or Claude Code app links. Includes the selected company, environment and setup brief, never credential values. Does not launch an app or change configuration.
| Argument | Type | Description |
|---|---|---|
| id | string | |
| name* | string | |
| fields | array | |
| company* | string | Summer company ID |
| description | string | |
| environment* | string | Environment that owns the resource |
| instructions | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"name"
],
"properties": {
"id": {
"type": "string",
"pattern": "^custom-[a-z0-9-]{1,64}$"
},
"name": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"label",
"required"
],
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Z][A-Z0-9_]{0,127}$",
"description": "Credential variable name, for example STRIPE_READ_KEY"
},
"label": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
"default": [],
"maxItems": 128
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"description": {
"type": "string",
"default": "",
"maxLength": 500
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"instructions": {
"type": "string",
"default": "",
"maxLength": 4000
}
},
"additionalProperties": false
}Read shared investigation runs, saved plans, approval state and execution receipts across the verified customer’s cases, including historical issues. Each run retains its original support_case_id; use that ID for write operations and original run evidence.
| Argument | Type | Description |
|---|---|---|
| case* | string | |
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"case"
],
"properties": {
"case": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}Ask Summer to investigate the case, or revise a saved plan with feedback. Completion is not approval.
| Argument | Type | Description |
|---|---|---|
| case* | string | |
| company* | string | Summer company ID |
| request* | any | |
| environment* | string | Environment that owns the resource |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"case",
"request"
],
"properties": {
"case": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"request": {
"oneOf": [
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"const": "investigate"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"plan_request_id",
"feedback"
],
"properties": {
"kind": {
"type": "string",
"const": "revise"
},
"feedback": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"plan_request_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}
]
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Upload a new company knowledge document with original revision history. The shared library is used by all roles and environments. Existing document IDs are refused. API reference: https://api.gosummer.ai/v1/openapi.json
| Argument | Type | Description |
|---|---|---|
| id* | string | Knowledge document ID |
| path* | string | |
| tags | array | |
| reason* | string | |
| company* | string | Summer company ID |
| content* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"id",
"path",
"content",
"reason"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9]+(?:[.-][a-z0-9]+)*$",
"maxLength": 120,
"description": "Knowledge document ID"
},
"path": {
"type": "string",
"pattern": "^company\\/[a-z0-9][a-z0-9._/-]*\\.md$",
"maxLength": 240
},
"tags": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9-]{1,60}$"
},
"default": [],
"maxItems": 20
},
"reason": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"content": {
"type": "string",
"maxLength": 1000000,
"minLength": 1
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Edit an existing company knowledge document with the expected revision and a reason. Affects every environment and later runs.
| Argument | Type | Description |
|---|---|---|
| reason* | string | |
| status* | string | |
| company* | string | Summer company ID |
| content* | string | |
| document* | string | Knowledge document ID |
| revision* | integer | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"document",
"revision",
"content",
"status",
"reason"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"status": {
"enum": [
"active",
"retired"
],
"type": "string"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"content": {
"type": "string",
"maxLength": 1000000,
"minLength": 1
},
"document": {
"type": "string",
"pattern": "^[a-z0-9]+(?:[.-][a-z0-9]+)*$",
"maxLength": 120,
"description": "Knowledge document ID"
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Read one company knowledge document and its current revision.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| document* | string | Knowledge document ID |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"document"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"document": {
"type": "string",
"pattern": "^[a-z0-9]+(?:[.-][a-z0-9]+)*$",
"maxLength": 120,
"description": "Knowledge document ID"
}
},
"additionalProperties": false
}Read the edit history of a company knowledge document.
| Argument | Type | Description |
|---|---|---|
| offset | integer | |
| company* | string | Summer company ID |
| document* | string | Knowledge document ID |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"document"
],
"properties": {
"offset": {
"type": "integer",
"maximum": 100000,
"minimum": 0
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"document": {
"type": "string",
"pattern": "^[a-z0-9]+(?:[.-][a-z0-9]+)*$",
"maxLength": 120,
"description": "Knowledge document ID"
}
},
"additionalProperties": false
}List current company knowledge documents. Knowledge is company-wide, not per environment. Pass tag to list documents with that tag, such as an integration name (slack, beluga, mdi), which is how Summer shows knowledge related to an integration.
| Argument | Type | Description |
|---|---|---|
| tag | string | |
| query | string | |
| offset | integer | |
| company* | string | Summer company ID |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"tag": {
"type": "string",
"pattern": "^[a-z0-9-]{1,60}$"
},
"query": {
"type": "string",
"maxLength": 200
},
"offset": {
"type": "integer",
"maximum": 100000,
"minimum": 0
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
}
},
"additionalProperties": false
}Read assistant settings per installation and whether the managed runtime is enabled.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}Update assistant instructions and escalation permission with the expected revision. Company facts live in shared knowledge. Cannot raise the spending limit.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| revision* | integer | |
| settings* | object | |
| environment* | string | Environment that owns the resource |
| installation* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"installation",
"revision",
"settings"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"settings": {
"type": "object",
"required": [
"enabled",
"instructions",
"budget_cents"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Automatic replies. The approved setup grant includes production activation within the current spending limit."
},
"budget_cents": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "Cannot exceed the current limit through the API"
},
"instructions": {
"type": "string",
"maxLength": 50000,
"minLength": 1
},
"daily_budget_cents": {
"type": "integer",
"maximum": 1000000,
"minimum": 100,
"description": "Daily spending limit. Delegated clients may keep or reduce the saved limit."
},
"escalation_enabled": {
"type": "boolean",
"description": "Allow investigation handoffs. Set false for a product and sales chat."
},
"lead_capture_enabled": {
"type": "boolean",
"description": "Offer an optional consent-based contact form in chat."
},
"max_concurrent_chats": {
"type": "integer",
"maximum": 200,
"minimum": 1
}
},
"additionalProperties": false
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"installation": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Pause the assistant in one conversation so a person can take over, or ask it to resume. Pausing stops automatic replies immediately.
| Argument | Type | Description |
|---|---|---|
| paused* | boolean | |
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
| conversation* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"conversation",
"paused"
],
"properties": {
"paused": {
"type": "boolean"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"conversation": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Read original Messenger messages with saved human sender_display_name, contact form details, read receipts and attachments without marking the chat read.
| Argument | Type | Description |
|---|---|---|
| view | string | |
| after | integer | |
| company* | string | |
| file_id | string | |
| environment* | string | |
| conversation* | string | |
| receipt_after | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"conversation"
],
"properties": {
"view": {
"enum": [
"state"
],
"type": "string"
},
"after": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"file_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
},
"conversation": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"receipt_after": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}Search and filter the complete Messenger inbox, including visitor conversations without Ops cases.
| Argument | Type | Description |
|---|---|---|
| q | string | |
| sort | string | |
| limit | integer | |
| cursor | string | |
| filter | string | |
| company* | string | |
| environment* | string | |
| conversation | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"q": {
"type": "string",
"maxLength": 200
},
"sort": {
"enum": [
"waiting",
"activity",
"overdue",
"newest"
],
"type": "string"
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1
},
"cursor": {
"type": "string",
"pattern": "^[1-9]\\d{0,5}$"
},
"filter": {
"enum": [
"open",
"needs_human",
"plan_ready",
"agent_working",
"waiting_customer",
"resolved",
"all"
],
"type": "string"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
},
"conversation": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}Check forwarding, the DNS record and sending status for one support email address now. Records the latest sending status; sends nothing.
| Argument | Type | Description |
|---|---|---|
| channel* | string | |
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"channel"
],
"properties": {
"channel": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}Add a support email address. Summer creates its private forwarding address and signing key and returns the DNS record to add. The address starts off; nothing is sent.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
| display_name* | string | Sender name customers see on replies. |
| idempotency_key | string | Reuse the same key when retrying the same change |
| installation_id | string | Messenger installation whose inbox the emails join. Defaults to the first installation. |
| support_address* | string | The address customers already write to, such as [email protected]. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"support_address",
"display_name"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"display_name": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "Sender name customers see on replies."
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"installation_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Messenger installation whose inbox the emails join. Defaults to the first installation."
},
"support_address": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 254,
"description": "The address customers already write to, such as [email protected]."
}
},
"additionalProperties": false
}Read support email addresses: the private forwarding address, the one DNS record to add, whether mail has arrived, sending status, Gmail forwarding codes and emails that need a look.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}Change the sender name or turn a support email address on or off, with the expected version. Turning on needs one received email. Turning off keeps every email but stops new conversations and replies.
| Argument | Type | Description |
|---|---|---|
| channel* | string | |
| company* | string | Summer company ID |
| enabled | boolean | |
| version* | integer | |
| environment* | string | Environment that owns the resource |
| display_name | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"channel",
"version"
],
"properties": {
"channel": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"enabled": {
"type": "boolean"
},
"version": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"display_name": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Create an installation with a client-chosen ID. The one-time signing key goes to the trusted local helper, never to model-visible output. Returns a local CLI command when a secret is involved.
| Argument | Type | Description |
|---|---|---|
| id* | string | New installation ID chosen by the client, so a retry cannot create a duplicate |
| company* | string | Summer company ID |
| settings* | object | |
| environment* | string | Environment that owns the resource |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"id",
"settings"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "New installation ID chosen by the client, so a retry cannot create a duplicate"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"settings": {
"type": "object",
"required": [
"enabled",
"guests_enabled",
"display_name",
"allowed_origins",
"privacy_url",
"fallback_url",
"office_hours"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Live widget. The approved setup grant includes production installation and activation."
},
"routing": {
"type": "object",
"properties": {
"offer_url": {
"type": "string",
"maxLength": 512
},
"catalog_url": {
"type": "string",
"maxLength": 512
},
"offer_label": {
"type": "string",
"maxLength": 80
},
"sign_in_url": {
"type": "string",
"maxLength": 512
},
"clinician_url": {
"type": "string",
"maxLength": 512
},
"destination_origins": {
"type": "array",
"items": {
"type": "string",
"maxLength": 256
},
"maxItems": 10
}
},
"additionalProperties": false
},
"identity": {
"type": "object",
"properties": {
"mode": {
"enum": [
"human",
"ai"
],
"type": "string",
"default": "human",
"description": "Named support persona (default) or a visible AI assistant label."
},
"name_style": {
"enum": [
"neutral",
"female"
],
"type": "string",
"default": "neutral"
},
"custom_name": {
"type": "string",
"default": "",
"maxLength": 80
},
"teammate_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"description": "Show this company teammate's uploaded photo beside automated replies. Put the teammate's name in custom_name."
},
"suggested_photo": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-z]+(-[a-z]+)*\\.[a-z]+(-[a-z]+)*$"
},
{
"type": "null"
}
],
"description": "Show the photo of a suggested teammate name (its first.last address part from teammates.names.list) beside automated replies. Put that name in custom_name."
}
},
"description": "Agent name and AI disclosure. Defaults to named support with a neutral first name and last initial.",
"additionalProperties": false
},
"logo_url": {
"type": "string",
"maxLength": 1024,
"description": "Public company logo shown in the header"
},
"privacy_url": {
"type": "string",
"maxLength": 512
},
"display_name": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "Company name shown in the Messenger header"
},
"fallback_url": {
"type": "string",
"maxLength": 512
},
"office_hours": {
"type": "string",
"maxLength": 200
},
"presentation": {
"type": "object",
"properties": {
"colors": {
"type": "object",
"default": {},
"properties": {
"accent": {
"type": "string",
"default": "#a95424",
"pattern": "^#[0-9a-f]{6}$",
"maxLength": 7,
"minLength": 7
},
"customer_bubble": {
"type": "string",
"default": "#eef1e7",
"pattern": "^#[0-9a-f]{6}$",
"maxLength": 7,
"minLength": 7
}
},
"additionalProperties": false
},
"actions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"required": [
"type",
"label",
"url",
"show_on_home",
"show_in_chat"
],
"properties": {
"url": {
"type": "string",
"maxLength": 1024
},
"type": {
"type": "string",
"const": "link"
},
"label": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"show_in_chat": {
"type": "boolean"
},
"show_on_home": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"label",
"show_on_home",
"show_in_chat"
],
"properties": {
"type": {
"type": "string",
"const": "lead_capture"
},
"label": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"show_in_chat": {
"type": "boolean"
},
"show_on_home": {
"type": "boolean"
}
},
"additionalProperties": false
}
]
},
"default": [
{
"type": "lead_capture",
"label": "Request follow-up",
"show_in_chat": true,
"show_on_home": false
}
],
"maxItems": 6
},
"chat_label": {
"type": "string",
"default": "Message support",
"maxLength": 60,
"minLength": 1
},
"lead_capture": {
"type": "object",
"default": {},
"properties": {
"title": {
"type": "string",
"default": "Request follow-up",
"maxLength": 100,
"minLength": 1
},
"name_label": {
"type": "string",
"default": "Name",
"maxLength": 60,
"minLength": 1
},
"show_phone": {
"type": "boolean",
"default": false
},
"description": {
"type": "string",
"default": "Leave your details so our team can contact you.",
"maxLength": 300,
"minLength": 1
},
"email_label": {
"type": "string",
"default": "Email",
"maxLength": 60,
"minLength": 1
},
"phone_label": {
"type": "string",
"default": "Phone number",
"maxLength": 60,
"minLength": 1
},
"consent_text": {
"type": "string",
"default": "I agree that this team may contact me using these details.",
"maxLength": 500,
"minLength": 1,
"description": "Consent copy. Add any number of inline links with [Privacy Policy](https://example.com/privacy). Links open in a new tab; HTML is displayed as text. The exact copy and URLs are retained with the submission."
},
"show_company": {
"type": "boolean",
"default": true
},
"show_message": {
"type": "boolean",
"default": true
},
"submit_label": {
"type": "string",
"default": "Send my details",
"maxLength": 60,
"minLength": 1
},
"company_label": {
"type": "string",
"default": "Company",
"maxLength": 60,
"minLength": 1
},
"custom_fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"label"
],
"properties": {
"key": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,49}$"
},
"type": {
"enum": [
"text",
"select"
],
"type": "string",
"default": "text"
},
"label": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"options": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"default": [],
"maxItems": 20
},
"required": {
"type": "boolean",
"default": false
}
},
"additionalProperties": false
},
"default": [],
"maxItems": 10
},
"follow_up_url": {
"anyOf": [
{
"type": "string",
"maxLength": 1024
},
{
"type": "string",
"const": ""
}
],
"default": ""
},
"message_label": {
"type": "string",
"default": "Message",
"maxLength": 60,
"minLength": 1
},
"phone_required": {
"type": "boolean",
"default": false
},
"follow_up_label": {
"type": "string",
"default": "Book a call",
"maxLength": 60,
"minLength": 1
},
"success_message": {
"type": "string",
"default": "Your details are saved for our team.",
"maxLength": 200,
"minLength": 1
},
"company_required": {
"type": "boolean",
"default": false
},
"required_before_chat": {
"type": "boolean",
"default": false
}
},
"additionalProperties": false
},
"thread_title": {
"type": "string",
"default": "What's on your mind?",
"maxLength": 100,
"minLength": 1
},
"welcome_title": {
"type": "string",
"default": "How can we help?",
"maxLength": 100,
"minLength": 1
},
"header_description": {
"type": "string",
"default": "Support team",
"maxLength": 100,
"minLength": 1
},
"thread_description": {
"type": "string",
"default": "Ask a question here. We can help you find the next step.",
"maxLength": 300,
"minLength": 1
},
"welcome_description": {
"type": "string",
"default": "",
"maxLength": 300
}
},
"description": "Company chat colors, welcome and chat copy, home/chat links and contact form labels. Consent text supports multiple [label](https://example.com/policy) links; other copy is plain text. Links use HTTPS. Scoped to this installation.",
"additionalProperties": false
},
"guests_enabled": {
"type": "boolean"
},
"allowed_origins": {
"type": "array",
"items": {
"type": "string",
"maxLength": 256
},
"maxItems": 20,
"minItems": 1,
"description": "Exact website origins, https (http://localhost allowed in staging)"
},
"guest_challenge_hourly": {
"type": "integer",
"maximum": 10000,
"minimum": 1
},
"guest_attachments_enabled": {
"type": "boolean"
},
"guest_daily_conversation_limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1
}
},
"additionalProperties": false
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}List Messenger installations in this environment. Signing keys are never returned.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}Issue a new signing key. Existing signed sessions end. The key goes to the trusted local helper only. Returns a local CLI command when a secret is involved.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
| installation* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"installation",
"expected_version"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"installation": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
}
},
"additionalProperties": false
}Update installation settings with the expected version. Keeps the signing key.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| settings* | object | |
| environment* | string | Environment that owns the resource |
| installation* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"installation",
"expected_version",
"settings"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"settings": {
"type": "object",
"required": [
"enabled",
"guests_enabled",
"display_name",
"allowed_origins",
"privacy_url",
"fallback_url",
"office_hours"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Live widget. The approved setup grant includes production installation and activation."
},
"routing": {
"type": "object",
"properties": {
"offer_url": {
"type": "string",
"maxLength": 512
},
"catalog_url": {
"type": "string",
"maxLength": 512
},
"offer_label": {
"type": "string",
"maxLength": 80
},
"sign_in_url": {
"type": "string",
"maxLength": 512
},
"clinician_url": {
"type": "string",
"maxLength": 512
},
"destination_origins": {
"type": "array",
"items": {
"type": "string",
"maxLength": 256
},
"maxItems": 10
}
},
"additionalProperties": false
},
"identity": {
"type": "object",
"properties": {
"mode": {
"enum": [
"human",
"ai"
],
"type": "string",
"default": "human",
"description": "Named support persona (default) or a visible AI assistant label."
},
"name_style": {
"enum": [
"neutral",
"female"
],
"type": "string",
"default": "neutral"
},
"custom_name": {
"type": "string",
"default": "",
"maxLength": 80
},
"teammate_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"description": "Show this company teammate's uploaded photo beside automated replies. Put the teammate's name in custom_name."
},
"suggested_photo": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-z]+(-[a-z]+)*\\.[a-z]+(-[a-z]+)*$"
},
{
"type": "null"
}
],
"description": "Show the photo of a suggested teammate name (its first.last address part from teammates.names.list) beside automated replies. Put that name in custom_name."
}
},
"description": "Agent name and AI disclosure. Defaults to named support with a neutral first name and last initial.",
"additionalProperties": false
},
"logo_url": {
"type": "string",
"maxLength": 1024,
"description": "Public company logo shown in the header"
},
"privacy_url": {
"type": "string",
"maxLength": 512
},
"display_name": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "Company name shown in the Messenger header"
},
"fallback_url": {
"type": "string",
"maxLength": 512
},
"office_hours": {
"type": "string",
"maxLength": 200
},
"presentation": {
"type": "object",
"properties": {
"colors": {
"type": "object",
"default": {},
"properties": {
"accent": {
"type": "string",
"default": "#a95424",
"pattern": "^#[0-9a-f]{6}$",
"maxLength": 7,
"minLength": 7
},
"customer_bubble": {
"type": "string",
"default": "#eef1e7",
"pattern": "^#[0-9a-f]{6}$",
"maxLength": 7,
"minLength": 7
}
},
"additionalProperties": false
},
"actions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"required": [
"type",
"label",
"url",
"show_on_home",
"show_in_chat"
],
"properties": {
"url": {
"type": "string",
"maxLength": 1024
},
"type": {
"type": "string",
"const": "link"
},
"label": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"show_in_chat": {
"type": "boolean"
},
"show_on_home": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"label",
"show_on_home",
"show_in_chat"
],
"properties": {
"type": {
"type": "string",
"const": "lead_capture"
},
"label": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"show_in_chat": {
"type": "boolean"
},
"show_on_home": {
"type": "boolean"
}
},
"additionalProperties": false
}
]
},
"default": [
{
"type": "lead_capture",
"label": "Request follow-up",
"show_in_chat": true,
"show_on_home": false
}
],
"maxItems": 6
},
"chat_label": {
"type": "string",
"default": "Message support",
"maxLength": 60,
"minLength": 1
},
"lead_capture": {
"type": "object",
"default": {},
"properties": {
"title": {
"type": "string",
"default": "Request follow-up",
"maxLength": 100,
"minLength": 1
},
"name_label": {
"type": "string",
"default": "Name",
"maxLength": 60,
"minLength": 1
},
"show_phone": {
"type": "boolean",
"default": false
},
"description": {
"type": "string",
"default": "Leave your details so our team can contact you.",
"maxLength": 300,
"minLength": 1
},
"email_label": {
"type": "string",
"default": "Email",
"maxLength": 60,
"minLength": 1
},
"phone_label": {
"type": "string",
"default": "Phone number",
"maxLength": 60,
"minLength": 1
},
"consent_text": {
"type": "string",
"default": "I agree that this team may contact me using these details.",
"maxLength": 500,
"minLength": 1,
"description": "Consent copy. Add any number of inline links with [Privacy Policy](https://example.com/privacy). Links open in a new tab; HTML is displayed as text. The exact copy and URLs are retained with the submission."
},
"show_company": {
"type": "boolean",
"default": true
},
"show_message": {
"type": "boolean",
"default": true
},
"submit_label": {
"type": "string",
"default": "Send my details",
"maxLength": 60,
"minLength": 1
},
"company_label": {
"type": "string",
"default": "Company",
"maxLength": 60,
"minLength": 1
},
"custom_fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"label"
],
"properties": {
"key": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,49}$"
},
"type": {
"enum": [
"text",
"select"
],
"type": "string",
"default": "text"
},
"label": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"options": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"default": [],
"maxItems": 20
},
"required": {
"type": "boolean",
"default": false
}
},
"additionalProperties": false
},
"default": [],
"maxItems": 10
},
"follow_up_url": {
"anyOf": [
{
"type": "string",
"maxLength": 1024
},
{
"type": "string",
"const": ""
}
],
"default": ""
},
"message_label": {
"type": "string",
"default": "Message",
"maxLength": 60,
"minLength": 1
},
"phone_required": {
"type": "boolean",
"default": false
},
"follow_up_label": {
"type": "string",
"default": "Book a call",
"maxLength": 60,
"minLength": 1
},
"success_message": {
"type": "string",
"default": "Your details are saved for our team.",
"maxLength": 200,
"minLength": 1
},
"company_required": {
"type": "boolean",
"default": false
},
"required_before_chat": {
"type": "boolean",
"default": false
}
},
"additionalProperties": false
},
"thread_title": {
"type": "string",
"default": "What's on your mind?",
"maxLength": 100,
"minLength": 1
},
"welcome_title": {
"type": "string",
"default": "How can we help?",
"maxLength": 100,
"minLength": 1
},
"header_description": {
"type": "string",
"default": "Support team",
"maxLength": 100,
"minLength": 1
},
"thread_description": {
"type": "string",
"default": "Ask a question here. We can help you find the next step.",
"maxLength": 300,
"minLength": 1
},
"welcome_description": {
"type": "string",
"default": "",
"maxLength": 300
}
},
"description": "Company chat colors, welcome and chat copy, home/chat links and contact form labels. Consent text supports multiple [label](https://example.com/policy) links; other copy is plain text. Links use HTTPS. Scoped to this installation.",
"additionalProperties": false
},
"guests_enabled": {
"type": "boolean"
},
"allowed_origins": {
"type": "array",
"items": {
"type": "string",
"maxLength": 256
},
"maxItems": 20,
"minItems": 1,
"description": "Exact website origins, https (http://localhost allowed in staging)"
},
"guest_challenge_hourly": {
"type": "integer",
"maximum": 10000,
"minimum": 1
},
"guest_attachments_enabled": {
"type": "boolean"
},
"guest_daily_conversation_limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1
}
},
"additionalProperties": false
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"installation": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
}
},
"additionalProperties": false
}Read consented website leads for this company and environment. Includes volunteered contact details and original submission references.
| Argument | Type | Description |
|---|---|---|
| before | string | |
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"before": {
"type": "string",
"maxLength": 120
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}Read voice chat settings per installation, the voice services and their voices, published help article count and the voice assistant's update status.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}Update voice chat settings with the expected revision. Summer updates the voice assistant from these settings and the company's published help articles.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| revision* | integer | |
| settings* | object | |
| environment* | string | Environment that owns the resource |
| installation* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"installation",
"revision",
"settings"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"settings": {
"type": "object",
"required": [
"enabled",
"audience",
"allowed_subjects",
"voice_id",
"instructions",
"vocabulary"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Show the voice button in chat for the chosen audience."
},
"audience": {
"enum": [
"accounts",
"signed_in",
"everyone"
],
"type": "string",
"description": "accounts: only allowed_subjects; signed_in: any verified account; everyone: visitors too."
},
"provider": {
"enum": [
"openai",
"elevenlabs"
],
"type": "string",
"description": "Voice service. openai (OpenAI Realtime) is the default. Omit to keep the saved choice."
},
"voice_id": {
"type": "string",
"pattern": "^[A-Za-z0-9]{8,40}$",
"description": "ElevenLabs voice: one of the voices listed by messenger.voice.read."
},
"vocabulary": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"maxItems": 100,
"description": "Words speech recognition should expect, such as product names."
},
"instructions": {
"type": "string",
"maxLength": 20000,
"description": "Optional company instructions added to the standard voice instructions."
},
"openai_voice": {
"enum": [
"alloy",
"ash",
"ballad",
"coral",
"echo",
"sage",
"shimmer",
"verse",
"marin",
"cedar"
],
"type": "string",
"description": "OpenAI voice: one of the openai_voices listed by messenger.voice.read. Omit to keep the saved choice."
},
"allowed_subjects": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 50,
"description": "Verified account subjects your site sends at sign-in. Used when audience is accounts."
}
},
"additionalProperties": false
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"installation": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Read demo pharmacy-call voice, vocabulary and change history. Starts no call.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| environment* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
}
},
"additionalProperties": false
}Save the demo pharmacy-call voice and vocabulary with the expected revision. Starts no call.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| revision* | integer | |
| voice_id* | any | |
| vocabulary* | array | |
| environment* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"revision",
"voice_id",
"vocabulary"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"voice_id": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
]
},
"vocabulary": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"maxItems": 100
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}File an export or deletion request for human review. Cannot approve, perform or attest completion of the work.
| Argument | Type | Description |
|---|---|---|
| id* | string | |
| kind* | string | |
| scope* | array | |
| reason* | string | |
| company* | string | |
| requestKind* | string | |
| subjectKind* | string | |
| subjectLabel* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
Read privacy export/deletion requests, status and original event history. Does not export or delete data.
| Argument | Type | Description |
|---|---|---|
| company* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}Record an evidence-backed assessment or correction. Does not approve a plan or customer action.
| Argument | Type | Description |
|---|---|---|
| id* | string | |
| kind* | string | |
| notes* | string | |
| checks* | object | |
| company* | string | |
| outcome* | string | |
| runKind* | string | |
| corrects* | any | |
| scenarioId* | string | |
| runReference* |
Read evidence-backed corrections to previous quality assessments.
| Argument | Type | Description |
|---|---|---|
| company* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}Read one scenario and its saved assessments.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| scenario* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"scenario"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"scenario": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}Read quality scenarios, assessments and current outcomes.
| Argument | Type | Description |
|---|---|---|
| company* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}Create, revise or retire a quality scenario, with expected revision and reason.
| Argument | Type | Description |
|---|---|---|
| id* | string | |
| kind* | string | |
| fields* | object | |
| reason* | string | |
| company* | string | |
| retired* | boolean | |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expectedRevision* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"kind",
"id",
"expectedRevision",
"retired",
"reason",
"fields"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"kind": {
"type": "string",
"const": "scenario"
},
"fields": {
"type": "object",
"required": [
"title",
"cohort",
"difficulty",
"sourceKind",
"sourceCaseCode",
"customerGoal",
"expectedFirstAction",
"remainingObligation",
"permittedEffects",
"prohibitedBehavior",
"closureEvidence"
],
"properties": {
"title": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"cohort": {
"enum": [
"fixed",
"held_out"
],
"type": "string"
},
"difficulty": {
"enum": [
"routine",
"complex",
"adversarial"
],
"type": "string"
},
"sourceKind": {
"enum": [
"historical",
"synthetic"
],
"type": "string"
},
"customerGoal": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"sourceCaseCode": {
"type": "string",
"maxLength": 40
},
"closureEvidence": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"permittedEffects": {
"type": "string",
"maxLength": 2000
},
"prohibitedBehavior": {
"type": "string",
"maxLength": 2000
},
"expectedFirstAction": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"remainingObligation": {
"type": "string",
"maxLength": 2000
}
}
},
"reason": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"retired": {
"type": "boolean"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expectedRevision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}Read outstanding customer promises and unfinished work.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| environment* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
}
},
"additionalProperties": false
}Read all-time and month-to-date credits, pending reservations and monthly usage in the company timezone.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| environment* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
}
},
"additionalProperties": false
}Read delivery attempts, failures and recorded results. Does not retry a delivery.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| environment* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
}
},
"additionalProperties": false
}Read current response and resolution metrics in the company timezone.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| environment* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string"
}
},
"additionalProperties": false
}List investigation and execution runs across cases, newest first, with status, plan approval and date filters.
| Argument | Type | Description |
|---|---|---|
| kind | string | |
| sort | string | |
| cursor | string | |
| status | string | approval: plans waiting for human approval; review: runs that need a person to check them |
| company* | string | Summer company ID |
| executed | any | Only approved executions, with their effects |
| environment* | string | Environment that owns the resource |
| created_after | string | ISO 8601 time with an offset, for example 2026-10-01T00:00:00Z |
| created_before | string | ISO 8601 time with an offset, for example 2026-10-01T00:00:00Z |
Read original revisions of a saved reply.
| Argument | Type | Description |
|---|---|---|
| reply* | string | |
| company* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"reply"
],
"properties": {
"reply": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}Read company saved replies, optionally including retired replies.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| retired | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"retired": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"true",
"false"
],
"type": "string"
}
]
}
},
"additionalProperties": false
}Create, edit, retire or restore a saved reply with its expected revision and reason. Sends nothing. API reference: https://api.gosummer.ai/v1/openapi.json
| Argument | Type | Description |
|---|---|---|
| id* | string | |
| body* | string | |
| name* | string | |
| reason* | string | |
| company* | string | |
| retired* | boolean | |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expectedRevision* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"id",
"expectedRevision",
"name",
"body",
"retired",
"reason"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"body": {
"type": "string",
"maxLength": 4000,
"minLength": 1
},
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"reason": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"retired": {
"type": "boolean"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expectedRevision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}Remove an owned inbox view, retaining the database's ownership checks.
| Argument | Type | Description |
|---|---|---|
| id* | string | |
| kind* | string | |
| company* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"kind",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"kind": {
"type": "string",
"const": "delete"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Read this person's saved inbox views and shared company views.
| Argument | Type | Description |
|---|---|---|
| company* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}Save a personal or shared inbox view. Known case filters are normalized by the same service as the UI.
| Argument | Type | Description |
|---|---|---|
| id* | string | |
| kind* | string | |
| name* | string | |
| query* | string | |
| shared* | boolean | |
| company* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"kind",
"id",
"name",
"query",
"shared"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"kind": {
"type": "string",
"const": "save"
},
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"query": {
"type": "string",
"maxLength": 500
},
"shared": {
"type": "boolean"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}List the company's service accounts.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
}
},
"additionalProperties": false
}Create, update, rotate or disable a service account. A new secret goes to the trusted local helper only. Returns a local CLI command when a secret is involved.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| scopes* | array | |
| account* | string | |
| company* | string | Summer company ID |
| disable | boolean | |
| environments* | array | |
| rotate_secret | boolean | |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer | Current version you expect; 0 when the resource does not exist yet |
Set which vendor a selected Slack channel is for and what it is used for, with a reason. Null clears a field. Changes guidance for agents and people; sends no message and changes no channel access.
| Argument | Type | Description |
|---|---|---|
| reason* | string | |
| vendor* | any | The vendor this channel is with, such as Beluga Health. |
| channel* | string | Slack channel ID from slack.channels.list |
| company* | string | Summer company ID |
| purpose* | any | What the channel is used for, in one or two plain sentences. |
| idempotency_key | string | Reuse the same key when retrying the same change |
| installation_id* | string | The Slack connection from slack.channels.list. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"channel",
"installation_id",
"vendor",
"purpose",
"reason"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"vendor": {
"anyOf": [
{
"type": "string",
"maxLength": 60,
"minLength": 1
},
{
"type": "null"
}
],
"description": "The vendor this channel is with, such as Beluga Health."
},
"channel": {
"type": "string",
"pattern": "^[CG][A-Z0-9]+$",
"description": "Slack channel ID from slack.channels.list"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"purpose": {
"anyOf": [
{
"type": "string",
"pattern": "^[^\\u0000-\\u001f]*$",
"maxLength": 400,
"minLength": 1
},
{
"type": "null"
}
],
"description": "What the channel is used for, in one or two plain sentences."
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"installation_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The Slack connection from slack.channels.list."
}
},
"additionalProperties": false
}List the Slack channels the company selected for Summer, with read and post access and each channel's vendor and purpose. Agents see the vendor and purpose with every vendor Slack read.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
}
},
"additionalProperties": false
}Allow or stop approved agent replies in one vendor Slack channel, with the expected version from teammates.setup.status and a reason. Each reply still needs a person to approve its exact text. Sends no message.
| Argument | Type | Description |
|---|---|---|
| reason* | string | |
| allowed* | boolean | |
| channel* | string | Slack channel ID from teammates.setup.status |
| company* | string | Summer company ID |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer | postingVersion from teammates.setup.status; 0 before the first change. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"channel",
"allowed",
"expected_version",
"reason"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"allowed": {
"type": "boolean"
},
"channel": {
"type": "string",
"pattern": "^[CG][A-Z0-9]+$",
"description": "Slack channel ID from teammates.setup.status"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "postingVersion from teammates.setup.status; 0 before the first change."
}
},
"additionalProperties": false
}Read the support name and avatar shown on Summer's approved Slack replies, whether the Slack install allows them, and the change history.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
}
},
"additionalProperties": false
}Set the support name and avatar on Summer's approved Slack replies, with the expected revision and a reason. Null values use the plain Summer Ellis identity. Sends no message.
| Argument | Type | Description |
|---|---|---|
| reason* | string | |
| company* | string | Summer company ID |
| revision* | integer | Current revision from slack.identity.read; 0 before the first save. |
| avatar_url* | any | Public https image link for the reply avatar. |
| display_name* | any | Support name shown on replies, such as the company's support team name. Slack still marks the post as an app. |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"revision",
"display_name",
"avatar_url",
"reason"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Current revision from slack.identity.read; 0 before the first save."
},
"avatar_url": {
"anyOf": [
{
"type": "string",
"pattern": "^https:\\/\\/[^\\s<>\"]+$",
"maxLength": 500
},
{
"type": "null"
}
],
"description": "Public https image link for the reply avatar."
},
"display_name": {
"anyOf": [
{
"type": "string",
"maxLength": 80,
"minLength": 1
},
{
"type": "null"
}
],
"description": "Support name shown on replies, such as the company's support team name. Slack still marks the post as an app."
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Choose who posts approved vendor Slack replies: the Summer Ellis app (null) or a Summer Teammate, which then posts from its own Slack account. Uses the revision from slack.identity.read and a reason. Sends no message.
| Argument | Type | Description |
|---|---|---|
| reason* | string | |
| company* | string | Summer company ID |
| revision* | integer | Current revision from slack.identity.read; 0 before the first save. |
| teammate_id* | any | An active teammate from teammates.list, or null for the Summer Ellis app. |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"revision",
"teammate_id",
"reason"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Current revision from slack.identity.read; 0 before the first save."
},
"teammate_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"description": "An active teammate from teammates.list, or null for the Summer Ellis app."
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Read business hours, holidays, response commitments and scheduled policy revisions.
| Argument | Type | Description |
|---|---|---|
| company* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}Save business hours and response commitments with the expected revision and an effective date.
| Argument | Type | Description |
|---|---|---|
| reason* | string | |
| company* | string | |
| calendar* | object | |
| commitments* | array | |
| effectiveAt* | any | |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expectedRevision* | integer | |
| pauseOnCustomerWait* | boolean |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"expectedRevision",
"calendar",
"commitments",
"pauseOnCustomerWait",
"effectiveAt",
"reason"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"calendar": {
"type": "object",
"required": [
"timezone",
"periods",
"holidays"
],
"properties": {
"periods": {
"type": "array",
"items": {
"type": "object",
"required": [
"day",
"open",
"close"
],
"properties": {
"day": {
"type": "integer",
"maximum": 6,
"minimum": 0
},
"open": {
"type": "string",
"maxLength": 5
},
"close": {
"type": "string",
"maxLength": 5
}
},
"additionalProperties": false
},
"maxItems": 28
},
"holidays": {
"type": "array",
"items": {
"type": "object",
"required": [
"date",
"name"
],
"properties": {
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1
}
},
"additionalProperties": false
},
"maxItems": 100
},
"timezone": {
"type": "string",
"maxLength": 100
}
},
"additionalProperties": false
},
"commitments": {
"type": "array",
"items": {
"type": "object",
"required": [
"kind",
"targetMinutes"
],
"properties": {
"kind": {
"enum": [
"first_response",
"next_response",
"resolution"
],
"type": "string"
},
"targetMinutes": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"maxItems": 3
},
"effectiveAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expectedRevision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"pauseOnCustomerWait": {
"type": "boolean"
}
},
"additionalProperties": false
}Add a teammate. A managed teammate gets [email protected], unique across Summer. A company-managed teammate uses the company's own address. Invites no one, joins no Slack workspace and sends nothing.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| request* | any | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"request"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"request": {
"oneOf": [
{
"type": "object",
"required": [
"kind",
"first_name",
"last_name",
"reason"
],
"properties": {
"kind": {
"type": "string",
"const": "managed"
},
"reason": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"last_name": {
"type": "string",
"maxLength": 30,
"minLength": 1
},
"avatar_url": {
"anyOf": [
{
"type": "string",
"pattern": "^https:\\/\\/[^\\s<>\"]+$",
"maxLength": 500,
"description": "Public https image link for the teammate's photo."
},
{
"type": "null"
}
]
},
"first_name": {
"type": "string",
"maxLength": 30,
"minLength": 1
},
"use_suggested_photo": {
"type": "boolean",
"description": "For a name from teammates.names.list: give the teammate that name's suggested photo. Summer stores it like an upload, so it also becomes the Slack photo when Slack is connected. Ignores avatar_url."
}
},
"description": "Summer gives the teammate [email protected] and keeps its mailbox.",
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"first_name",
"last_name",
"email_address",
"reason"
],
"properties": {
"kind": {
"type": "string",
"const": "company"
},
"reason": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"last_name": {
"type": "string",
"maxLength": 30,
"minLength": 1
},
"avatar_url": {
"anyOf": [
{
"type": "string",
"pattern": "^https:\\/\\/[^\\s<>\"]+$",
"maxLength": 500,
"description": "Public https image link for the teammate's photo."
},
{
"type": "null"
}
]
},
"first_name": {
"type": "string",
"maxLength": 30,
"minLength": 1
},
"email_address": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 254,
"description": "The company's own address for this teammate. Summer never reads this mailbox."
}
},
"description": "The company manages the email and Slack account and connects Slack to Summer.",
"additionalProperties": false
}
]
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}List the company's teammates with their address, photo, status, unread mail count and Slack connection.
| Argument | Type | Description |
|---|---|---|
| company* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}Read one message in a Summer-managed teammate's mailbox, including its text. Marks it read for the team.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| message* | string | |
| teammate* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"teammate",
"message"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"message": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"teammate": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}List mail received by a Summer-managed teammate, newest first, with sender, subject and a short preview. Company-managed teammates have no mailbox in Summer.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| before | string | Messages received before this time |
| company* | string | |
| teammate* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"teammate"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"before": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Messages received before this time"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"teammate": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}List suggested female and gender-neutral teammate names whose gosummer.ai address is still free. Each has a suggested photo_url to show; create with use_suggested_photo: true to add that name, address and photo together. Any typed first and last name also works.
| Argument | Type | Description |
|---|---|---|
| company* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}Live status of each step to get a teammate posting approved replies in vendor Slack channels: Slack connected, teammate added, Slack invitation received, teammate connected, chosen as sender, in each vendor channel, and agent replies allowed there. Unreadable sources are reported as unknown.
| Argument | Type | Description |
|---|---|---|
| company* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}Join a public Slack channel as the connected teammate. Sends no message. A private or shared channel needs someone in it to /invite the teammate in Slack.
| Argument | Type | Description |
|---|---|---|
| channel* | string | Public Slack channel ID from teammates.setup.status |
| company* | string | |
| teammate* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"teammate",
"channel"
],
"properties": {
"channel": {
"type": "string",
"pattern": "^C[A-Z0-9]{2,20}$",
"description": "Public Slack channel ID from teammates.setup.status"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"teammate": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Disconnect a teammate's Slack account from Summer and delete its saved token. The Slack account itself stays in the workspace. Connecting needs the Slack sign-in in Summer settings.
| Argument | Type | Description |
|---|---|---|
| reason* | string | |
| company* | string | |
| teammate* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"teammate",
"reason"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"teammate": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Change a teammate's shown name, photo or status, with the expected revision and a reason. Retiring disconnects Slack and keeps the address reserved.
| Argument | Type | Description |
|---|---|---|
| reason* | string | |
| status* | string | Retired teammates keep their address forever and disconnect from Slack. |
| company* | string | |
| revision* | integer | Current revision from teammates.list. |
| teammate* | string | |
| avatar_url* | any | |
| display_name* | string | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"teammate",
"revision",
"display_name",
"avatar_url",
"status",
"reason"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"status": {
"enum": [
"active",
"retired"
],
"type": "string",
"description": "Retired teammates keep their address forever and disconnect from Slack."
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Current revision from teammates.list.",
"exclusiveMinimum": 0
},
"teammate": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"avatar_url": {
"anyOf": [
{
"type": "string",
"pattern": "^https:\\/\\/[^\\s<>\"]+$",
"maxLength": 500,
"description": "Public https image link for the teammate's photo."
},
{
"type": "null"
}
]
},
"display_name": {
"type": "string",
"maxLength": 80,
"minLength": 3
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Run supported harmless checks. Unsupported checks are reported as unsupported, never as passed.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| targets* | array | |
| environment* | string | Environment that owns the resource |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"targets"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"targets": {
"type": "array",
"items": {
"enum": [
"credentials",
"providers",
"slack",
"messenger"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}List webhook endpoints and delivery state.
| Argument | Type | Description |
|---|---|---|
| company* | string | Summer company ID |
| environment* | string | Environment that owns the resource |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
}
},
"additionalProperties": false
}Queue past events after a cursor for delivery again to one endpoint. Receivers deduplicate by event ID.
| Argument | Type | Description |
|---|---|---|
| after* | string | |
| limit | integer | |
| company* | string | Summer company ID |
| webhook* | string | |
| environment* | string | Environment that owns the resource |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"webhook",
"after"
],
"properties": {
"after": {
"type": "string",
"pattern": "^\\d{1,18}$"
},
"limit": {
"type": "integer",
"default": 200,
"maximum": 1000,
"minimum": 1
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"webhook": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}Create, update, rotate or disable a signed webhook endpoint. A new signing secret goes to the trusted local helper only. Returns a local CLI command when a secret is involved.
| Argument | Type | Description |
|---|---|---|
| url* | string | |
| company* | string | Summer company ID |
| disable | boolean | |
| webhook* | string | |
| environment* | string | Environment that owns the resource |
| event_types* | array | |
| rotate_secret | boolean | |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_version* | integer | Current version you expect; 0 when the resource does not exist yet |
Read eligible teammates and automatic owner/reviewer routing settings.
| Argument | Type | Description |
|---|---|---|
| company* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}Save automatic owner/reviewer routing with the expected version. Does not grant roles or approval authority.
| Argument | Type | Description |
|---|---|---|
| company* | string | |
| version* | integer | |
| issue_mode* | string | |
| review_mode* | string | |
| issue_members* | array | |
| review_members* | array | |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"version",
"issue_mode",
"review_mode",
"issue_members",
"review_members"
],
"properties": {
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"issue_mode": {
"enum": [
"off",
"default",
"round_robin"
],
"type": "string"
},
"review_mode": {
"enum": [
"off",
"default",
"round_robin"
],
"type": "string"
},
"issue_members": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"maxItems": 100
},
"review_members": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"maxItems": 100
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"case",
"execution",
"approval_hash",
"authorization"
],
"properties": {
"case": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"execution": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"approval_hash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"authorization": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "The operator's instruction authorizing this exact work, retained in the approval audit. This is context, not an identity attestation."
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}| any |
| expected_version* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"asset",
"expected_version",
"alt_text",
"caption",
"provenance",
"reason"
],
"properties": {
"asset": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"reason": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"caption": {
"type": "string",
"maxLength": 2000
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"retired": {
"type": "boolean",
"default": false
},
"alt_text": {
"type": "string",
"maxLength": 500
},
"provenance": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"transcript": {
"type": "string",
"default": "",
"maxLength": 100000
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"poster_asset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}| byte_length* |
| integer |
| idempotency_key | string | Reuse the same key when retrying the same change |
| poster_asset_id | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"id",
"filename",
"media_type",
"byte_length",
"sha256",
"alt_text",
"caption",
"provenance"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"caption": {
"type": "string",
"maxLength": 2000
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"alt_text": {
"type": "string",
"maxLength": 500
},
"filename": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"media_type": {
"enum": [
"text/markdown",
"image/png",
"image/jpeg",
"image/webp",
"image/gif",
"video/mp4",
"video/webm",
"text/vtt",
"application/pdf"
],
"type": "string"
},
"provenance": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"transcript": {
"type": "string",
"default": "",
"maxLength": 100000
},
"byte_length": {
"type": "integer",
"maximum": 268435456,
"minimum": 1
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"poster_asset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}| integer |
| Current version you expect; 0 when the resource does not exist yet |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"capability",
"expected_version",
"state",
"notes",
"evidence"
],
"properties": {
"notes": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"state": {
"enum": [
"not_checked",
"passed",
"failed",
"blocked",
"not_applicable"
],
"type": "string"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"evidence": {
"type": "string",
"maxLength": 2000
},
"capability": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{1,79}$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"fulfillment": {
"type": "object",
"required": [
"kind",
"discovery",
"location"
],
"properties": {
"kind": {
"enum": [
"api",
"browser",
"knowledge",
"other",
"combined"
],
"type": "string"
},
"location": {
"type": "string",
"maxLength": 1000,
"minLength": 1,
"description": "Guide, tool, API documentation or portal location; never a secret"
},
"discovery": {
"type": "string",
"maxLength": 1000,
"minLength": 1,
"description": "How Summer can discover this path"
}
},
"additionalProperties": false
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Current version you expect; 0 when the resource does not exist yet"
}
},
"additionalProperties": false
}| autonomy | string |
| category | string |
| internal | any |
| language | string |
| severity | string |
| followUps | any |
| sentiment | string |
| unmatched | any |
| dismissals | any |
| reviewMine | any |
| workstream | string |
| environment* | string | Environment that owns the resource |
| escalations | any |
| responseDue | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"lane": {
"enum": [
"all",
"customer_request",
"proactive_issue",
"source_review"
],
"type": "string"
},
"mine": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"true",
"false"
],
"type": "string"
}
]
},
"plan": {
"enum": [
"all",
"ready"
],
"type": "string"
},
"sort": {
"enum": [
"priority",
"newest",
"oldest",
"due",
"activity",
"autonomy_desc",
"autonomy_asc"
],
"type": "string"
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1
},
"cursor": {
"type": "string",
"pattern": "^[1-9]\\d{0,5}$"
},
"status": {
"enum": [
"open",
"in_progress",
"resolved",
"closed",
"active",
"all"
],
"type": "string"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"pastSla": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"true",
"false"
],
"type": "string"
}
]
},
"sandbox": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"true",
"false"
],
"type": "string"
}
]
},
"autonomy": {
"type": "string",
"maxLength": 40
},
"category": {
"type": "string",
"maxLength": 80
},
"internal": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"true",
"false"
],
"type": "string"
}
]
},
"language": {
"enum": [
"en",
"es",
"other"
],
"type": "string"
},
"severity": {
"enum": [
"normal",
"high",
"urgent"
],
"type": "string"
},
"followUps": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"true",
"false"
],
"type": "string"
}
]
},
"sentiment": {
"enum": [
"happy",
"neutral",
"upset",
"angry",
"sad",
"mixed",
"unknown"
],
"type": "string"
},
"unmatched": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"true",
"false"
],
"type": "string"
}
]
},
"dismissals": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"true",
"false"
],
"type": "string"
}
]
},
"reviewMine": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"true",
"false"
],
"type": "string"
}
]
},
"workstream": {
"type": "string",
"maxLength": 80
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"escalations": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"true",
"false"
],
"type": "string"
}
]
},
"responseDue": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"true",
"false"
],
"type": "string"
}
]
}
},
"additionalProperties": false
}| include_test | any | Include staff and test accounts |
| created_after | string | ISO 8601 time with an offset, for example 2026-10-01T00:00:00Z |
| activity_after | string | Cases updated at or after this time |
| created_before | string | ISO 8601 time with an offset, for example 2026-10-01T00:00:00Z |
| activity_before | string | Cases updated before this time |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"minLength": 2,
"description": "Customer name, email, phone, support code, order or tracking number, Stripe, MDI, Beluga or GEN ID, or care session ID. With messages=true, also words in customer and team messages."
},
"dob": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Exact date of birth, YYYY-MM-DD. With q, keeps only customers that match both."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Default 25"
},
"status": {
"enum": [
"open",
"resolved",
"all"
],
"type": "string",
"description": "Default all"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"messages": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"true",
"false"
],
"type": "string"
}
],
"description": "Also search message text for q. Needs q."
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"include_test": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"true",
"false"
],
"type": "string"
}
],
"description": "Include staff and test accounts"
},
"created_after": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "ISO 8601 time with an offset, for example 2026-10-01T00:00:00Z"
},
"activity_after": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Cases updated at or after this time"
},
"created_before": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "ISO 8601 time with an offset, for example 2026-10-01T00:00:00Z"
},
"activity_before": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Cases updated before this time"
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"name",
"timezone",
"workflow",
"note",
"expected_version"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"note": {
"type": "string",
"maxLength": 1000
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"timezone": {
"type": "string",
"maxLength": 100
},
"workflow": {
"enum": [
"support",
"order_status",
"billing",
"custom"
],
"type": "string"
},
"email_subject": {
"type": "string",
"pattern": "^[^\\r\\n\\t]*$",
"maxLength": 150,
"description": "Subject customers see on a new support email, such as \"Your Example Co support request\". Replies to a customer's email keep their subject. Leave out to keep the saved subject; an empty string clears it."
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Current version you expect; 0 when the resource does not exist yet"
}
},
"additionalProperties": false
}| source_url* |
| any |
| verified_at | any |
| idempotency_key | string | Reuse the same key when retrying the same change |
| expected_revision* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"article",
"expected_revision",
"slug",
"title",
"summary",
"topic",
"content",
"asset_ids",
"source_url",
"reason"
],
"properties": {
"slug": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 100
},
"title": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"topic": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"reason": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"article": {
"type": "string",
"pattern": "^[a-z0-9]+(?:[.-][a-z0-9]+)*$",
"maxLength": 100
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"content": {
"type": "string",
"maxLength": 500000,
"minLength": 1
},
"summary": {
"type": "string",
"maxLength": 1000
},
"asset_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"maxItems": 100
},
"source_url": {
"anyOf": [
{
"type": "string",
"const": ""
},
{
"type": "string",
"format": "uri",
"maxLength": 1000
}
]
},
"verified_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
],
"default": null
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"integration",
"expected_version",
"name",
"fields"
],
"properties": {
"name": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"label",
"required"
],
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Z][A-Z0-9_]{0,127}$",
"description": "Credential variable name, for example STRIPE_READ_KEY"
},
"label": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
"maxItems": 128,
"minItems": 1
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"description": {
"type": "string",
"default": "",
"maxLength": 500
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"integration": {
"type": "string",
"pattern": "^custom-[a-z0-9-]{1,64}$"
},
"instructions": {
"type": "string",
"default": "",
"maxLength": 4000
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Current version you expect; 0 when the resource does not exist yet"
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"kind",
"id",
"requestKind",
"subjectKind",
"subjectLabel",
"scope",
"reason"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"kind": {
"type": "string",
"const": "request"
},
"scope": {
"type": "array",
"items": {
"enum": [
"messages",
"files",
"cases",
"approvals",
"search",
"jobs",
"provider_copies",
"knowledge",
"settings"
],
"type": "string"
},
"maxItems": 9,
"minItems": 1
},
"reason": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"requestKind": {
"enum": [
"export",
"deletion"
],
"type": "string"
},
"subjectKind": {
"enum": [
"company",
"customer",
"staff"
],
"type": "string"
},
"subjectLabel": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}| string |
| idempotency_key | string | Reuse the same key when retrying the same change |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"kind",
"id",
"scenarioId",
"runKind",
"runReference",
"outcome",
"checks",
"notes",
"corrects"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"kind": {
"type": "string",
"const": "assessment"
},
"notes": {
"type": "string",
"maxLength": 4000,
"minLength": 1
},
"checks": {
"type": "object",
"required": [
"original_evidence",
"customer_outcome",
"safe_exact_action",
"clarity",
"follow_through"
],
"properties": {
"clarity": {
"enum": [
"pass",
"fail",
"unknown"
],
"type": "string"
},
"follow_through": {
"enum": [
"pass",
"fail",
"unknown"
],
"type": "string"
},
"customer_outcome": {
"enum": [
"pass",
"fail",
"unknown"
],
"type": "string"
},
"original_evidence": {
"enum": [
"pass",
"fail",
"unknown"
],
"type": "string"
},
"safe_exact_action": {
"enum": [
"pass",
"fail",
"unknown"
],
"type": "string"
}
}
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"outcome": {
"enum": [
"verified_complete",
"still_open",
"blocked",
"unsafe",
"unknown"
],
"type": "string"
},
"runKind": {
"enum": [
"live_case",
"saved_run",
"manual_walkthrough"
],
"type": "string"
},
"corrects": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"scenarioId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"runReference": {
"type": "string",
"maxLength": 120
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment"
],
"properties": {
"kind": {
"enum": [
"all",
"investigation",
"execution"
],
"type": "string"
},
"sort": {
"enum": [
"results",
"created",
"started",
"approved"
],
"type": "string"
},
"cursor": {
"type": "string",
"pattern": "^[1-9]\\d{0,5}$"
},
"status": {
"enum": [
"all",
"approval",
"active",
"queued",
"review",
"completed",
"stopped",
"waiting"
],
"type": "string",
"description": "approval: plans waiting for human approval; review: runs that need a person to check them"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"executed": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"true",
"false"
],
"type": "string"
}
],
"description": "Only approved executions, with their effects"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"created_after": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "ISO 8601 time with an offset, for example 2026-10-01T00:00:00Z"
},
"created_before": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "ISO 8601 time with an offset, for example 2026-10-01T00:00:00Z"
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"account",
"name",
"environments",
"scopes",
"expected_version"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"scopes": {
"type": "array",
"items": {
"enum": [
"events.read",
"capabilities.read"
],
"type": "string"
},
"maxItems": 2,
"minItems": 1
},
"account": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"disable": {
"type": "boolean",
"default": false
},
"environments": {
"type": "array",
"items": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"maxItems": 2,
"minItems": 1
},
"rotate_secret": {
"type": "boolean",
"default": false
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Current version you expect; 0 when the resource does not exist yet"
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company",
"environment",
"webhook",
"url",
"event_types",
"expected_version"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"maxLength": 512
},
"company": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Summer company ID"
},
"disable": {
"type": "boolean",
"default": false
},
"webhook": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"environment": {
"enum": [
"staging",
"production"
],
"type": "string",
"description": "Environment that owns the resource"
},
"event_types": {
"type": "array",
"items": {
"type": "string",
"pattern": "^(\\*|[a-z][a-z0-9_.]{2,80})$"
},
"maxItems": 32,
"minItems": 1
},
"rotate_secret": {
"type": "boolean",
"default": false
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{8,128}$",
"description": "Reuse the same key when retrying the same change"
},
"expected_version": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Current version you expect; 0 when the resource does not exist yet"
}
},
"additionalProperties": false
}