{ "openapi": "3.1.0", "info": { "title": "Agent Notify Agent API", "version": "2.0.0", "description": "Generated from the SDK protocol 2 registry mapped to the Go transport. Bearer credentials are server-side secrets. Input cross-field rules (exclusive reminder timing, option IDs, parameter references and time windows) are validated by the server and TypeScript SDK; JSON Schema alone does not encode every refinement. Provider acceptance is not receipt; an answer is not an execution permit. Browser account configuration, Slack callbacks and MCP JSON-RPC are separate protocols." }, "servers": [ { "url": "/" } ], "paths": { "/api/v1/server/templates": { "get": { "operationId": "listTemplates", "summary": "listTemplates", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listTemplatesInput/properties/query/properties/limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listTemplatesInput/properties/query/properties/cursor" } }, { "name": "status", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listTemplatesInput/properties/query/properties/status" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listTemplatesResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" }, "post": { "operationId": "createTemplate", "summary": "createTemplate", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/createTemplateInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/createTemplateInput/properties/headers/properties/If-Match" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createTemplateInput/properties/body" } } } }, "responses": { "201": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createTemplateResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" } }, "/api/v1/server/templates/{id}": { "get": { "operationId": "getTemplate", "summary": "getTemplate", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/getTemplateInput/properties/params/properties/id" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getTemplateResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" }, "patch": { "operationId": "updateTemplate", "summary": "updateTemplate", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/updateTemplateInput/properties/params/properties/id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/updateTemplateInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/updateTemplateInput/properties/headers/properties/If-Match" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateTemplateInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateTemplateResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" }, "delete": { "operationId": "deleteTemplate", "summary": "deleteTemplate", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/deleteTemplateInput/properties/params/properties/id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/deleteTemplateInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/deleteTemplateInput/properties/headers/properties/If-Match" } } ], "responses": { "204": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" } }, "/api/v1/server/templates/{id}/history": { "get": { "operationId": "getTemplateHistory", "summary": "getTemplateHistory", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/getTemplateHistoryInput/properties/params/properties/id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/getTemplateHistoryInput/properties/query/properties/limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/getTemplateHistoryInput/properties/query/properties/cursor" } }, { "name": "status", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/getTemplateHistoryInput/properties/query/properties/status" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getTemplateHistoryResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" } }, "/api/v1/server/segments": { "get": { "operationId": "listSegments", "summary": "listSegments", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listSegmentsInput/properties/query/properties/limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listSegmentsInput/properties/query/properties/cursor" } }, { "name": "status", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listSegmentsInput/properties/query/properties/status" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listSegmentsResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" }, "post": { "operationId": "createSegment", "summary": "createSegment", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/createSegmentInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/createSegmentInput/properties/headers/properties/If-Match" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createSegmentInput/properties/body" } } } }, "responses": { "201": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createSegmentResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" } }, "/api/v1/server/segments/{id}": { "get": { "operationId": "getSegment", "summary": "getSegment", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/getSegmentInput/properties/params/properties/id" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getSegmentResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" }, "patch": { "operationId": "updateSegment", "summary": "updateSegment", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/updateSegmentInput/properties/params/properties/id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/updateSegmentInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/updateSegmentInput/properties/headers/properties/If-Match" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateSegmentInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateSegmentResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" }, "delete": { "operationId": "deleteSegment", "summary": "deleteSegment", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/deleteSegmentInput/properties/params/properties/id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/deleteSegmentInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/deleteSegmentInput/properties/headers/properties/If-Match" } } ], "responses": { "204": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" } }, "/api/v1/server/segments/{id}/history": { "get": { "operationId": "getSegmentHistory", "summary": "getSegmentHistory", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/getSegmentHistoryInput/properties/params/properties/id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/getSegmentHistoryInput/properties/query/properties/limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/getSegmentHistoryInput/properties/query/properties/cursor" } }, { "name": "status", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/getSegmentHistoryInput/properties/query/properties/status" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getSegmentHistoryResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" } }, "/api/v1/server/campaigns": { "get": { "operationId": "listCampaigns", "summary": "listCampaigns", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listCampaignsInput/properties/query/properties/limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listCampaignsInput/properties/query/properties/cursor" } }, { "name": "status", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listCampaignsInput/properties/query/properties/status" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listCampaignsResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" }, "post": { "operationId": "createCampaign", "summary": "createCampaign", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/createCampaignInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/createCampaignInput/properties/headers/properties/If-Match" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createCampaignInput/properties/body" } } } }, "responses": { "201": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createCampaignResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" } }, "/api/v1/server/campaigns/{id}": { "get": { "operationId": "getCampaign", "summary": "getCampaign", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/getCampaignInput/properties/params/properties/id" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getCampaignResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" }, "patch": { "operationId": "updateCampaign", "summary": "updateCampaign", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/updateCampaignInput/properties/params/properties/id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/updateCampaignInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/updateCampaignInput/properties/headers/properties/If-Match" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateCampaignInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateCampaignResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" }, "delete": { "operationId": "deleteCampaign", "summary": "deleteCampaign", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/deleteCampaignInput/properties/params/properties/id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/deleteCampaignInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/deleteCampaignInput/properties/headers/properties/If-Match" } } ], "responses": { "204": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" } }, "/api/v1/server/campaigns/{id}/history": { "get": { "operationId": "getCampaignHistory", "summary": "getCampaignHistory", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/getCampaignHistoryInput/properties/params/properties/id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/getCampaignHistoryInput/properties/query/properties/limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/getCampaignHistoryInput/properties/query/properties/cursor" } }, { "name": "status", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/getCampaignHistoryInput/properties/query/properties/status" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getCampaignHistoryResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" } }, "/api/v1/server/campaigns/{id}/send": { "post": { "operationId": "sendCampaign", "summary": "sendCampaign", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/sendCampaignInput/properties/params/properties/id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/sendCampaignInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/sendCampaignInput/properties/headers/properties/If-Match" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sendCampaignResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" } }, "/api/v1/server/campaigns/{id}/pause": { "post": { "operationId": "pauseCampaign", "summary": "pauseCampaign", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/pauseCampaignInput/properties/params/properties/id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/pauseCampaignInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/pauseCampaignInput/properties/headers/properties/If-Match" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pauseCampaignResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" } }, "/api/v1/server/campaigns/{id}/resume": { "post": { "operationId": "resumeCampaign", "summary": "resumeCampaign", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/resumeCampaignInput/properties/params/properties/id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/resumeCampaignInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/resumeCampaignInput/properties/headers/properties/If-Match" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resumeCampaignResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" } }, "/api/v1/server/campaigns/{id}/stats": { "get": { "operationId": "getCampaignStats", "summary": "getCampaignStats", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/getCampaignStatsInput/properties/params/properties/id" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getCampaignStatsResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" } }, "/api/v1/server/flows": { "get": { "operationId": "listFlows", "summary": "listFlows", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listFlowsInput/properties/query/properties/limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listFlowsInput/properties/query/properties/cursor" } }, { "name": "status", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listFlowsInput/properties/query/properties/status" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listFlowsResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" }, "post": { "operationId": "createFlow", "summary": "createFlow", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/createFlowInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/createFlowInput/properties/headers/properties/If-Match" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createFlowInput/properties/body" } } } }, "responses": { "201": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createFlowResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" } }, "/api/v1/server/flows/{id}": { "get": { "operationId": "getFlow", "summary": "getFlow", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/getFlowInput/properties/params/properties/id" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getFlowResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" }, "patch": { "operationId": "updateFlow", "summary": "updateFlow", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/updateFlowInput/properties/params/properties/id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/updateFlowInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/updateFlowInput/properties/headers/properties/If-Match" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateFlowInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateFlowResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" }, "delete": { "operationId": "deleteFlow", "summary": "deleteFlow", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/deleteFlowInput/properties/params/properties/id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/deleteFlowInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/deleteFlowInput/properties/headers/properties/If-Match" } } ], "responses": { "204": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" } }, "/api/v1/server/flows/{id}/history": { "get": { "operationId": "getFlowHistory", "summary": "getFlowHistory", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/getFlowHistoryInput/properties/params/properties/id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/getFlowHistoryInput/properties/query/properties/limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/getFlowHistoryInput/properties/query/properties/cursor" } }, { "name": "status", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/getFlowHistoryInput/properties/query/properties/status" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getFlowHistoryResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" } }, "/api/v1/server/flows/{id}/activate": { "post": { "operationId": "activateFlow", "summary": "activateFlow", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/activateFlowInput/properties/params/properties/id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/activateFlowInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/activateFlowInput/properties/headers/properties/If-Match" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/activateFlowResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" } }, "/api/v1/server/flows/{id}/pause": { "post": { "operationId": "pauseFlow", "summary": "pauseFlow", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/pauseFlowInput/properties/params/properties/id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/pauseFlowInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/pauseFlowInput/properties/headers/properties/If-Match" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pauseFlowResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" } }, "/api/v1/server/flows/{id}/runs": { "get": { "operationId": "listFlowRuns", "summary": "listFlowRuns", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/listFlowRunsInput/properties/params/properties/id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listFlowRunsInput/properties/query/properties/limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listFlowRunsInput/properties/query/properties/cursor" } }, { "name": "status", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listFlowRunsInput/properties/query/properties/status" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listFlowRunsResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" } }, "/api/v1/server/flows/{id}/retry": { "post": { "operationId": "retryFlowRun", "summary": "retryFlowRun", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/retryFlowRunInput/properties/params/properties/id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/retryFlowRunInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/retryFlowRunInput/properties/headers/properties/If-Match" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retryFlowRunInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retryFlowRunResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" } }, "/api/integration/identity": { "get": { "operationId": "getIdentity", "summary": "Identify the current integration key and logical account site", "security": [ { "agentBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getIdentityResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "integration" } }, "/api/integration/site": { "get": { "operationId": "getSite", "summary": "Read the logical account namespace for the current integration", "security": [ { "agentBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getSiteResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "integration" } }, "/api/integration/channels": { "get": { "operationId": "listChannels", "summary": "Count configured channels within the key's account or recipient scope", "security": [ { "agentBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listChannelsResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "integration" } }, "/api/integration/machines": { "get": { "operationId": "listMachines", "summary": "List distinct machine IDs from agent-reported account history", "security": [ { "agentBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listMachinesResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" } }, "/api/authorization/rules": { "get": { "operationId": "listAuthorizationRules", "summary": "List authorization rules, including disabled rules; global and agent rules always, repository rules with repo_aware, session rules with scope_aware plus session_id", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "scope_aware", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listAuthorizationRulesInput/properties/query/properties/scope_aware" } }, { "name": "session_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listAuthorizationRulesInput/properties/query/properties/session_id" } }, { "name": "repo_aware", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listAuthorizationRulesInput/properties/query/properties/repo_aware" } }, { "name": "repo_key", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listAuthorizationRulesInput/properties/query/properties/repo_key" } }, { "name": "agent", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listAuthorizationRulesInput/properties/query/properties/agent" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listAuthorizationRulesResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" }, "post": { "operationId": "createAuthorizationRule", "summary": "Create an exact action rule and invalidate unconsumed authorizations", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/createAuthorizationRuleInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/createAuthorizationRuleInput/properties/headers/properties/If-Match" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createAuthorizationRuleInput/properties/body" } } } }, "responses": { "201": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createAuthorizationRuleResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" } }, "/api/authorization/rules/{id}": { "patch": { "operationId": "updateAuthorizationRule", "summary": "Change supplied rule fields, retaining identity and prior audit", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/updateAuthorizationRuleInput/properties/params/properties/id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/updateAuthorizationRuleInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/updateAuthorizationRuleInput/properties/headers/properties/If-Match" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateAuthorizationRuleInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateAuthorizationRuleResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" }, "delete": { "operationId": "deleteAuthorizationRule", "summary": "Delete a rule while preserving its recorded authorization history", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/deleteAuthorizationRuleInput/properties/params/properties/id" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/deleteAuthorizationRuleInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/deleteAuthorizationRuleInput/properties/headers/properties/If-Match" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteAuthorizationRuleResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" } }, "/api/authorization/evaluate": { "post": { "operationId": "authorizeAction", "summary": "Evaluate the exact action under current policy and stop controls", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/authorizeActionInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/authorizeActionInput/properties/headers/properties/If-Match" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorizeActionInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorizeActionResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "integration" } }, "/api/authorization/consume": { "post": { "operationId": "consumeAuthorization", "summary": "Consume an exact, settled authorization once before executing", "security": [ { "agentBearer": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consumeAuthorizationInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consumeAuthorizationResponse" } } } }, "409": { "description": "Execution refused or conflicting receipt", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizationRefusal" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "integration" } }, "/api/authorization/permits/{permitId}/receipt": { "post": { "operationId": "recordExecutionReceipt", "summary": "Record the immutable outcome of the permitted execution", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "permitId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/recordExecutionReceiptInput/properties/params/properties/permitId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recordExecutionReceiptInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recordExecutionReceiptResponse" } } } }, "409": { "description": "Execution refused or conflicting receipt", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionReceiptConflict" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "integration" } }, "/api/subscribers": { "get": { "operationId": "listSubscribers", "summary": "List completed browser subscriptions with account-bound cursor pagination", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listSubscribersInput/properties/query/properties/limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listSubscribersInput/properties/query/properties/cursor" } }, { "name": "status", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listSubscribersInput/properties/query/properties/status" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listSubscribersInput/properties/query/properties/external_id" } }, { "name": "tags", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listSubscribersInput/properties/query/properties/tags" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listSubscribersResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" } }, "/api/subscribers/count": { "get": { "operationId": "countSubscribers", "summary": "Count browser subscriptions by current delivery state", "security": [ { "agentBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/countSubscribersResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" } }, "/api/subscribers/{subscriberId}": { "get": { "operationId": "getSubscriber", "summary": "Read one browser subscription and its labels", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/getSubscriberInput/properties/params/properties/subscriberId" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getSubscriberResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" }, "patch": { "operationId": "updateSubscriber", "summary": "Replace supplied subscriber labels or custom data with an atomic audit", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/updateSubscriberInput/properties/params/properties/subscriberId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateSubscriberInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateSubscriberResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" }, "delete": { "operationId": "deleteSubscriber", "summary": "Permanently remove a browser subscription while preserving task history", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/deleteSubscriberInput/properties/params/properties/subscriberId" } } ], "responses": { "204": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" } }, "/api/notifications": { "post": { "operationId": "sendPush", "summary": "Queue a browser push notification with a fixed audience and a durable quota receipt", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/sendPushInput/properties/headers/properties/Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sendPushInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sendPushResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "integration" } }, "/api/notifications/{notificationId}": { "get": { "operationId": "getNotification", "summary": "Read notification content and aggregate push-service outcomes; acceptance is not receipt", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "notificationId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/getNotificationInput/properties/params/properties/notificationId" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getNotificationResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "integration" } }, "/api/v1/server/webhook-secret": { "get": { "operationId": "getWebhookSecret", "summary": "Read the account key for new REST decision callbacks; server master key only", "security": [ { "agentBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getWebhookSecretResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "integration" }, "post": { "operationId": "rotateWebhookSecret", "summary": "Rotate the account callback key; preserve Idempotency-Key when manually retrying", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/rotateWebhookSecretInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/rotateWebhookSecretInput/properties/headers/properties/If-Match" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rotateWebhookSecretResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "integration" } }, "/api/decisions": { "post": { "operationId": "createDecision", "summary": "Create a durable human decision using an integration key", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/createDecisionInput/properties/headers/properties/Idempotency-Key" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/createDecisionInput/properties/headers/properties/If-Match" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createDecisionInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createDecisionResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "integration" } }, "/api/approval-links/{owner}/{decisionId}": { "post": { "operationId": "previewApprovalLink", "summary": "Read one decision using its recipient-bound link token; no account session required", "security": [], "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/previewApprovalLinkInput/properties/params/properties/owner" } }, { "name": "decisionId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/previewApprovalLinkInput/properties/params/properties/decisionId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/previewApprovalLinkInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/previewApprovalLinkResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never" } }, "/api/approval-links/{owner}/{decisionId}/answer": { "post": { "operationId": "answerApprovalLink", "summary": "Answer one decision using its link token; preserve the same answer and idempotencyKey when retrying", "security": [], "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/answerApprovalLinkInput/properties/params/properties/owner" } }, { "name": "decisionId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/answerApprovalLinkInput/properties/params/properties/decisionId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/answerApprovalLinkInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/answerApprovalLinkResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never" } }, "/api/decisions/{decisionId}/approval-link": { "delete": { "operationId": "revokeApprovalLink", "summary": "Permanently revoke the decision's bearer link without cancelling the decision; server master key only", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "decisionId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/revokeApprovalLinkInput/properties/params/properties/decisionId" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/revokeApprovalLinkResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "integration" } }, "/api/decisions/{decisionId}": { "get": { "operationId": "getDecision", "summary": "Read the current decision; use waitForDecision to wait", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "decisionId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/getDecisionInput/properties/params/properties/decisionId" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDecisionResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "integration" }, "delete": { "operationId": "cancelDecision", "summary": "Cancel a pending decision while preserving a winning answer", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "decisionId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/cancelDecisionInput/properties/params/properties/decisionId" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cancelDecisionResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "idempotent", "x-required-key-kind": "integration" } }, "/api/decisions/{decisionId}/answer": { "post": { "operationId": "answerDecision", "summary": "Relay a user answer from a trusted product backend; requires a server master key", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "decisionId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/answerDecisionInput/properties/params/properties/decisionId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/answerDecisionInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/answerDecisionResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "idempotent", "x-required-key-kind": "integration" } }, "/api/server/enrollments": { "post": { "operationId": "enrollRecipient", "summary": "Create a short-lived recipient enrollment link for the authenticated web flow", "security": [ { "agentBearer": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/enrollRecipientInput/properties/body" } } } }, "responses": { "201": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/enrollRecipientResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "integration" } }, "/api/keys": { "post": { "operationId": "issueBoundKey", "summary": "Issue a recipient-bound key using a server master key; the secret is shown once", "security": [ { "agentBearer": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issueBoundKeyInput/properties/body" } } } }, "responses": { "201": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issueBoundKeyResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "server" }, "get": { "operationId": "listBoundKeys", "summary": "List recipient-bound key metadata using a server master key", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "kind", "in": "query", "required": true, "schema": { "type": "string", "const": "bound" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listBoundKeysResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "server" } }, "/api/keys/{id}": { "delete": { "operationId": "revokeBoundKey", "summary": "Revoke a recipient-bound key using a server master key", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/revokeBoundKeyInput/properties/params/properties/id" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/revokeBoundKeyResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "idempotent", "x-required-key-kind": "server" } }, "/api/keys/self": { "delete": { "operationId": "revokeCurrentKey", "summary": "Revoke the authenticating integration key; subsequent requests return 401", "security": [ { "agentBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/revokeCurrentKeyResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "integration" } }, "/api/server/recipients/reachability": { "get": { "operationId": "getReachability", "summary": "Inspect available recipient channels; bound keys force their own recipient, server keys require externalId", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "external_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/getReachabilityInput/properties/query/properties/external_id" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getReachabilityResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read", "x-required-key-kind": "integration" } }, "/api/tasks": { "post": { "operationId": "createTask", "summary": "Create a notification, reminder or question", "security": [ { "agentBearer": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createTaskInput/properties/body" } } } }, "responses": { "201": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createTaskResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "idempotent" }, "get": { "operationId": "listTasks", "summary": "List task history", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listTasksInput/properties/query/properties/cursor" } }, { "name": "status", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listTasksInput/properties/query/properties/status" } }, { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listTasksInput/properties/query/properties/limit" } }, { "name": "connection_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listTasksInput/properties/query/properties/connection_id" } }, { "name": "session_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listTasksInput/properties/query/properties/session_id" } }, { "name": "machine_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listTasksInput/properties/query/properties/machine_id" } }, { "name": "schedule_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listTasksInput/properties/query/properties/schedule_id" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listTasksResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read" } }, "/api/tasks/{id}": { "get": { "operationId": "getTask", "summary": "Read a task and its persisted answer", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/getTaskInput/properties/params/properties/id" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getTaskResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read" } }, "/api/tasks/{id}/actions": { "post": { "operationId": "respondToTask", "summary": "Respond to an own-account card; directed recipients require their own session", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/respondToTaskInput/properties/params/properties/id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/respondToTaskInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/respondToTaskResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "idempotent" } }, "/api/tasks/{id}/cancel": { "post": { "operationId": "cancelTask", "summary": "Cancel a task without changing an existing final result", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/cancelTaskInput/properties/params/properties/id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cancelTaskInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cancelTaskResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "idempotent" } }, "/api/tasks/{id}/handoff": { "post": { "operationId": "handoffQuestion", "summary": "Atomically transfer a question to the current client", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/handoffQuestionInput/properties/params/properties/id" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handoffQuestionResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never" } }, "/api/tasks/{id}/wait": { "post": { "operationId": "waitForResponse", "summary": "Wait once, retaining the task by default; optional atomic handoff", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/waitForResponseInput/properties/params/properties/id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waitForResponseInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waitForResponseResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never" } }, "/api/schedules": { "post": { "operationId": "createSchedule", "summary": "Create a recurring reminder or pomodoro", "security": [ { "agentBearer": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createScheduleInput/properties/body" } } } }, "responses": { "201": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createScheduleResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "idempotent" }, "get": { "operationId": "listSchedules", "summary": "List schedules", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listSchedulesInput/properties/query/properties/limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listSchedulesInput/properties/query/properties/cursor" } }, { "name": "status", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listSchedulesInput/properties/query/properties/status" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listSchedulesResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read" } }, "/api/schedules/{id}": { "get": { "operationId": "getSchedule", "summary": "Read schedule state", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/getScheduleInput/properties/params/properties/id" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getScheduleResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read" }, "patch": { "operationId": "updateSchedule", "summary": "Update a schedule at an expected version", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/updateScheduleInput/properties/params/properties/id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateScheduleInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateScheduleResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "idempotent" } }, "/api/schedules/{id}/control": { "post": { "operationId": "controlSchedule", "summary": "Pause, resume, skip or end a schedule", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/controlScheduleInput/properties/params/properties/id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/controlScheduleInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/controlScheduleResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "idempotent" } }, "/api/schedules/{id}/history": { "get": { "operationId": "scheduleHistory", "summary": "Read immutable schedule history", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/scheduleHistoryInput/properties/params/properties/id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/scheduleHistoryInput/properties/query/properties/limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/scheduleHistoryInput/properties/query/properties/cursor" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduleHistoryResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read" } }, "/api/sessions/heartbeat": { "post": { "operationId": "reportSession", "summary": "Report the authenticated Agent session", "security": [ { "agentBearer": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportSessionInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportSessionResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never" } }, "/api/sessions": { "get": { "operationId": "listSessions", "summary": "Read Agent sessions and pending tasks", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listSessionsInput/properties/query/properties/status" } }, { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listSessionsInput/properties/query/properties/limit" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listSessionsResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read" } }, "/api/recipients": { "get": { "operationId": "listRecipients", "summary": "Discover the account's invited and bound recipients", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listRecipientsInput/properties/query/properties/limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listRecipientsInput/properties/query/properties/cursor" } }, { "name": "status", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listRecipientsInput/properties/query/properties/status" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listRecipientsInput/properties/query/properties/external_id" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listRecipientsResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read" } }, "/api/recipients/{id}": { "get": { "operationId": "getRecipient", "summary": "Read a recipient profile", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/getRecipientInput/properties/params/properties/id" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getRecipientResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read" } }, "/api/audit": { "get": { "operationId": "queryAudit", "summary": "Query account and immutable task audit events", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/queryAuditInput/properties/query/properties/limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/queryAuditInput/properties/query/properties/cursor" } }, { "name": "scope", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/queryAuditInput/properties/query/properties/scope" } }, { "name": "recipient_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/queryAuditInput/properties/query/properties/recipient_id" } }, { "name": "schedule_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/queryAuditInput/properties/query/properties/schedule_id" } }, { "name": "task_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/queryAuditInput/properties/query/properties/task_id" } }, { "name": "connection_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/queryAuditInput/properties/query/properties/connection_id" } }, { "name": "session_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/queryAuditInput/properties/query/properties/session_id" } }, { "name": "machine_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/queryAuditInput/properties/query/properties/machine_id" } }, { "name": "agent_type", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/queryAuditInput/properties/query/properties/agent_type" } }, { "name": "decision", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/queryAuditInput/properties/query/properties/decision" } }, { "name": "event", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/queryAuditInput/properties/query/properties/event" } }, { "name": "q", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/queryAuditInput/properties/query/properties/q" } }, { "name": "from", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/queryAuditInput/properties/query/properties/from" } }, { "name": "to", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/queryAuditInput/properties/query/properties/to" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/queryAuditResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read" } }, "/api/deliveries": { "get": { "operationId": "listWebhookDeliveries", "summary": "Inspect persisted callback attempts", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listWebhookDeliveriesInput/properties/query/properties/limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listWebhookDeliveriesInput/properties/query/properties/cursor" } }, { "name": "task_id", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/listWebhookDeliveriesInput/properties/query/properties/task_id" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string", "const": "webhook" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listWebhookDeliveriesResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read" } }, "/api/decisions/{decisionId}/wait": { "post": { "operationId": "waitForDecision", "summary": "Wait once for a durable decision", "security": [ { "agentBearer": [] } ], "parameters": [ { "name": "decisionId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/waitForDecisionInput/properties/params/properties/decisionId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waitForDecisionInput/properties/body" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waitForDecisionResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "never", "x-required-key-kind": "integration" } }, "/healthz": { "get": { "operationId": "health", "summary": "Read service protocol health", "security": [], "parameters": [], "responses": { "200": { "description": "Success", "headers": { "X-Request-ID": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/healthResponse" } } } }, "default": { "description": "Validation, authentication, conflict, limit or service error. Go protocol 2 uses one flat envelope; agentNotifyCode is the stable machine code.", "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-retry-policy": "read" } } }, "components": { "securitySchemes": { "agentBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "Agent connection or integration token", "description": "Opaque Agent tokens and integration tokens are issued by the Go identity service. Operations with x-required-key-kind require the stated integration role; recipient-bound keys cannot access account-wide APIs or answer directed cards." } }, "schemas": { "Error": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "status": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "message": { "type": "string" }, "request_id": { "type": "string" }, "agentNotifyCode": { "type": "string" } }, "required": [ "error", "code", "status", "message", "request_id", "agentNotifyCode" ], "additionalProperties": {} }, "AuthorizationRefusal": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "refusal": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "not_executable", "subject_mismatch", "already_consumed", "expired", "stopped", "control_changed", "policy_changed", "not_approved", "policy_denied" ] }, "execution_state": { "type": "string", "enum": [ "consumed", "succeeded", "failed", "unknown" ] }, "permit_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)$" } }, "required": [ "reason" ], "additionalProperties": {} } }, "required": [ "refusal" ], "additionalProperties": {} }, "ExecutionReceiptConflict": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "permit_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)$" }, "execution_state": { "type": "string" }, "conflict": { "type": "boolean", "const": true } }, "required": [ "permit_id", "execution_state", "conflict" ], "additionalProperties": {} }, "listTemplatesInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "query": { "type": "object", "properties": { "limit": { "default": 30, "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 3000 }, "status": { "type": "string", "maxLength": 30 } }, "additionalProperties": false } }, "additionalProperties": false }, "listTemplatesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 }, "iconUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "imageUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "actionUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "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)$" }, "siteId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "title", "body", "id", "siteId", "name", "createdAt", "updatedAt", "version" ], "additionalProperties": {} } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": "string" } }, "required": [ "data", "hasMore" ], "additionalProperties": {} }, "createTemplateInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "body": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 }, "iconUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "imageUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "actionUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": [ "title", "body", "name" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "body" ], "additionalProperties": false }, "createTemplateResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 }, "iconUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "imageUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "actionUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "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)$" }, "siteId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "title", "body", "id", "siteId", "name", "createdAt", "updatedAt", "version" ], "additionalProperties": {} }, "getTemplateInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getTemplateResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 }, "iconUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "imageUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "actionUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "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)$" }, "siteId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "title", "body", "id", "siteId", "name", "createdAt", "updatedAt", "version" ], "additionalProperties": {} }, "updateTemplateInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "body": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 }, "iconUrl": { "anyOf": [ { "type": "string", "maxLength": 2048, "format": "uri" }, { "type": "null" } ] }, "imageUrl": { "anyOf": [ { "type": "string", "maxLength": 2048, "format": "uri" }, { "type": "null" } ] }, "actionUrl": { "anyOf": [ { "type": "string", "maxLength": 2048, "format": "uri" }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 120 } }, "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "params", "body" ], "additionalProperties": false }, "updateTemplateResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 }, "iconUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "imageUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "actionUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "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)$" }, "siteId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "title", "body", "id", "siteId", "name", "createdAt", "updatedAt", "version" ], "additionalProperties": {} }, "deleteTemplateInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getTemplateHistoryInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "query": { "type": "object", "properties": { "limit": { "default": 30, "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 3000 }, "status": { "type": "string", "maxLength": 30 } }, "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getTemplateHistoryResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "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)$" }, "event": { "type": "string" }, "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)))$" }, "requestId": { "type": "string" }, "connectionId": { "type": "string" }, "snapshot": {} }, "required": [ "id", "event", "at", "requestId", "connectionId", "snapshot" ], "additionalProperties": {} } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": "string" } }, "required": [ "data", "hasMore" ], "additionalProperties": {} }, "listSegmentsInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "query": { "type": "object", "properties": { "limit": { "default": 30, "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 3000 }, "status": { "type": "string", "maxLength": 30 } }, "additionalProperties": false } }, "additionalProperties": false }, "listSegmentsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "externalIds": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "subscriberIds": { "minItems": 1, "maxItems": 100, "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)$" } }, "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)$" }, "siteId": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "name", "id", "siteId", "createdAt", "updatedAt", "version" ], "additionalProperties": {} } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": "string" } }, "required": [ "data", "hasMore" ], "additionalProperties": {} }, "createSegmentInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "body": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "externalIds": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "subscriberIds": { "minItems": 1, "maxItems": 100, "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)$" } } }, "required": [ "name" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "body" ], "additionalProperties": false }, "createSegmentResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string" }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "externalIds": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "subscriberIds": { "minItems": 1, "maxItems": 100, "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)$" } }, "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)$" }, "siteId": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "name", "id", "siteId", "createdAt", "updatedAt", "version" ], "additionalProperties": {} }, "getSegmentInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getSegmentResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string" }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "externalIds": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "subscriberIds": { "minItems": 1, "maxItems": 100, "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)$" } }, "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)$" }, "siteId": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "name", "id", "siteId", "createdAt", "updatedAt", "version" ], "additionalProperties": {} }, "updateSegmentInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "body": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "tags": { "anyOf": [ { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, { "type": "null" } ] }, "externalIds": { "anyOf": [ { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, { "type": "null" } ] }, "subscriberIds": { "anyOf": [ { "minItems": 1, "maxItems": 100, "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)$" } }, { "type": "null" } ] } }, "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "params", "body" ], "additionalProperties": false }, "updateSegmentResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string" }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "externalIds": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "subscriberIds": { "minItems": 1, "maxItems": 100, "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)$" } }, "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)$" }, "siteId": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "name", "id", "siteId", "createdAt", "updatedAt", "version" ], "additionalProperties": {} }, "deleteSegmentInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getSegmentHistoryInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "query": { "type": "object", "properties": { "limit": { "default": 30, "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 3000 }, "status": { "type": "string", "maxLength": 30 } }, "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getSegmentHistoryResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "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)$" }, "event": { "type": "string" }, "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)))$" }, "requestId": { "type": "string" }, "connectionId": { "type": "string" }, "snapshot": {} }, "required": [ "id", "event", "at", "requestId", "connectionId", "snapshot" ], "additionalProperties": {} } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": "string" } }, "required": [ "data", "hasMore" ], "additionalProperties": {} }, "listCampaignsInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "query": { "type": "object", "properties": { "limit": { "default": 30, "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 3000 }, "status": { "type": "string", "maxLength": 30 } }, "additionalProperties": false } }, "additionalProperties": false }, "listCampaignsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 }, "iconUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "imageUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "actionUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "name": { "type": "string" }, "scheduledAt": { "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)))$" }, "segmentId": { "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)$" }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "templateId": { "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)$" }, "variables": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_.-]{0,39}$" }, "additionalProperties": { "type": "string", "maxLength": 500 } }, "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)$" }, "siteId": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "draft", "scheduled", "sending", "active", "paused", "completed", "cancelled" ] }, "notificationId": { "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)$" }, "lastError": { "type": "string" }, "totalTargeted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalDelivered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalClicked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalFailed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalSuppressed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "deliveryRate": { "type": "number", "minimum": 0, "maximum": 1 }, "clickRate": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": [ "title", "body", "name", "id", "siteId", "createdAt", "updatedAt", "version", "status", "totalTargeted", "totalSent", "totalDelivered", "totalClicked", "totalFailed", "totalSuppressed", "deliveryRate", "clickRate" ], "additionalProperties": {} } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": "string" } }, "required": [ "data", "hasMore" ], "additionalProperties": {} }, "createCampaignInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "body": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 }, "iconUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "imageUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "actionUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "scheduledAt": { "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)))$" }, "segmentId": { "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)$" }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "templateId": { "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)$" }, "variables": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_.-]{0,39}$" }, "additionalProperties": { "type": "string", "maxLength": 500 } } }, "required": [ "name" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "body" ], "additionalProperties": false }, "createCampaignResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 }, "iconUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "imageUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "actionUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "name": { "type": "string" }, "scheduledAt": { "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)))$" }, "segmentId": { "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)$" }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "templateId": { "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)$" }, "variables": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_.-]{0,39}$" }, "additionalProperties": { "type": "string", "maxLength": 500 } }, "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)$" }, "siteId": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "draft", "scheduled", "sending", "active", "paused", "completed", "cancelled" ] }, "notificationId": { "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)$" }, "lastError": { "type": "string" }, "totalTargeted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalDelivered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalClicked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalFailed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalSuppressed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "deliveryRate": { "type": "number", "minimum": 0, "maximum": 1 }, "clickRate": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": [ "title", "body", "name", "id", "siteId", "createdAt", "updatedAt", "version", "status", "totalTargeted", "totalSent", "totalDelivered", "totalClicked", "totalFailed", "totalSuppressed", "deliveryRate", "clickRate" ], "additionalProperties": {} }, "getCampaignInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getCampaignResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 }, "iconUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "imageUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "actionUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "name": { "type": "string" }, "scheduledAt": { "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)))$" }, "segmentId": { "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)$" }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "templateId": { "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)$" }, "variables": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_.-]{0,39}$" }, "additionalProperties": { "type": "string", "maxLength": 500 } }, "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)$" }, "siteId": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "draft", "scheduled", "sending", "active", "paused", "completed", "cancelled" ] }, "notificationId": { "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)$" }, "lastError": { "type": "string" }, "totalTargeted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalDelivered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalClicked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalFailed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalSuppressed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "deliveryRate": { "type": "number", "minimum": 0, "maximum": 1 }, "clickRate": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": [ "title", "body", "name", "id", "siteId", "createdAt", "updatedAt", "version", "status", "totalTargeted", "totalSent", "totalDelivered", "totalClicked", "totalFailed", "totalSuppressed", "deliveryRate", "clickRate" ], "additionalProperties": {} }, "updateCampaignInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "body": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 }, "iconUrl": { "anyOf": [ { "type": "string", "maxLength": 2048, "format": "uri" }, { "type": "null" } ] }, "imageUrl": { "anyOf": [ { "type": "string", "maxLength": 2048, "format": "uri" }, { "type": "null" } ] }, "actionUrl": { "anyOf": [ { "type": "string", "maxLength": 2048, "format": "uri" }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "scheduledAt": { "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" } ] }, "segmentId": { "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" } ] }, "tags": { "anyOf": [ { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, { "type": "null" } ] }, "templateId": { "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" } ] }, "variables": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_.-]{0,39}$" }, "additionalProperties": { "type": "string", "maxLength": 500 } }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "draft", "paused", "cancelled" ] } }, "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "params", "body" ], "additionalProperties": false }, "updateCampaignResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 }, "iconUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "imageUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "actionUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "name": { "type": "string" }, "scheduledAt": { "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)))$" }, "segmentId": { "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)$" }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "templateId": { "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)$" }, "variables": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_.-]{0,39}$" }, "additionalProperties": { "type": "string", "maxLength": 500 } }, "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)$" }, "siteId": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "draft", "scheduled", "sending", "active", "paused", "completed", "cancelled" ] }, "notificationId": { "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)$" }, "lastError": { "type": "string" }, "totalTargeted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalDelivered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalClicked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalFailed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalSuppressed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "deliveryRate": { "type": "number", "minimum": 0, "maximum": 1 }, "clickRate": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": [ "title", "body", "name", "id", "siteId", "createdAt", "updatedAt", "version", "status", "totalTargeted", "totalSent", "totalDelivered", "totalClicked", "totalFailed", "totalSuppressed", "deliveryRate", "clickRate" ], "additionalProperties": {} }, "deleteCampaignInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getCampaignHistoryInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "query": { "type": "object", "properties": { "limit": { "default": 30, "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 3000 }, "status": { "type": "string", "maxLength": 30 } }, "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getCampaignHistoryResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "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)$" }, "event": { "type": "string" }, "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)))$" }, "requestId": { "type": "string" }, "connectionId": { "type": "string" }, "snapshot": {} }, "required": [ "id", "event", "at", "requestId", "connectionId", "snapshot" ], "additionalProperties": {} } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": "string" } }, "required": [ "data", "hasMore" ], "additionalProperties": {} }, "sendCampaignInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "sendCampaignResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "campaignId": { "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)$" }, "notificationId": { "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)$" }, "queued": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "duplicate": { "type": "boolean" } }, "required": [ "success", "campaignId", "notificationId", "queued", "duplicate" ], "additionalProperties": {} }, "pauseCampaignInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "pauseCampaignResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 }, "iconUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "imageUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "actionUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "name": { "type": "string" }, "scheduledAt": { "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)))$" }, "segmentId": { "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)$" }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "templateId": { "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)$" }, "variables": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_.-]{0,39}$" }, "additionalProperties": { "type": "string", "maxLength": 500 } }, "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)$" }, "siteId": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "draft", "scheduled", "sending", "active", "paused", "completed", "cancelled" ] }, "notificationId": { "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)$" }, "lastError": { "type": "string" }, "totalTargeted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalDelivered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalClicked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalFailed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalSuppressed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "deliveryRate": { "type": "number", "minimum": 0, "maximum": 1 }, "clickRate": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": [ "title", "body", "name", "id", "siteId", "createdAt", "updatedAt", "version", "status", "totalTargeted", "totalSent", "totalDelivered", "totalClicked", "totalFailed", "totalSuppressed", "deliveryRate", "clickRate" ], "additionalProperties": {} }, "resumeCampaignInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "resumeCampaignResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 }, "iconUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "imageUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "actionUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "name": { "type": "string" }, "scheduledAt": { "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)))$" }, "segmentId": { "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)$" }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "templateId": { "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)$" }, "variables": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_.-]{0,39}$" }, "additionalProperties": { "type": "string", "maxLength": 500 } }, "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)$" }, "siteId": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "draft", "scheduled", "sending", "active", "paused", "completed", "cancelled" ] }, "notificationId": { "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)$" }, "lastError": { "type": "string" }, "totalTargeted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalDelivered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalClicked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalFailed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalSuppressed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "deliveryRate": { "type": "number", "minimum": 0, "maximum": 1 }, "clickRate": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": [ "title", "body", "name", "id", "siteId", "createdAt", "updatedAt", "version", "status", "totalTargeted", "totalSent", "totalDelivered", "totalClicked", "totalFailed", "totalSuppressed", "deliveryRate", "clickRate" ], "additionalProperties": {} }, "getCampaignStatsInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getCampaignStatsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "totalTargeted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalDelivered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalClicked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalFailed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalSuppressed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "deliveryRate": { "type": "number", "minimum": 0, "maximum": 1 }, "clickRate": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": [ "totalTargeted", "totalSent", "totalDelivered", "totalClicked", "totalFailed", "totalSuppressed", "deliveryRate", "clickRate" ], "additionalProperties": {} }, "listFlowsInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "query": { "type": "object", "properties": { "limit": { "default": 30, "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 3000 }, "status": { "type": "string", "maxLength": 30 } }, "additionalProperties": false } }, "additionalProperties": false }, "listFlowsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "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)$" }, "siteId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "description": { "type": "string" }, "triggerType": { "type": "string", "enum": [ "notification_click", "notification_impression", "notification_dismiss", "subscription", "unsubscription" ] }, "triggerCampaignId": { "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": { "type": "string", "enum": [ "draft", "active", "paused", "archived" ] }, "executionCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdBy": { "type": "string" }, "steps": { "type": "array", "items": { "type": "object", "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)$" }, "flowId": { "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)$" }, "stepOrder": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "stepType": { "type": "string", "enum": [ "send_notification", "delay", "exit" ] }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" } }, "required": [ "id", "flowId", "stepOrder", "stepType", "config", "createdAt", "updatedAt" ], "additionalProperties": {} } } }, "required": [ "id", "siteId", "name", "createdAt", "updatedAt", "version", "triggerType", "status", "executionCount", "createdBy", "steps" ], "additionalProperties": {} } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": "string" } }, "required": [ "data", "hasMore" ], "additionalProperties": {} }, "createFlowInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "body": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "type": "string", "maxLength": 2000 }, "triggerType": { "type": "string", "enum": [ "notification_click", "notification_impression", "notification_dismiss", "subscription", "unsubscription" ] }, "triggerCampaignId": { "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)$" }, "steps": { "default": [], "maxItems": 30, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "stepType": { "type": "string", "const": "send_notification" }, "config": { "type": "object", "properties": { "notification": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 }, "iconUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "imageUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "actionUrl": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "title", "body" ], "additionalProperties": false } }, "required": [ "notification" ], "additionalProperties": false } }, "required": [ "stepType", "config" ], "additionalProperties": false }, { "type": "object", "properties": { "stepType": { "type": "string", "const": "delay" }, "config": { "type": "object", "properties": { "delay": { "type": "object", "properties": { "value": { "type": "integer", "minimum": 1, "maximum": 31536000 }, "unit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days" ] } }, "required": [ "value", "unit" ], "additionalProperties": false } }, "required": [ "delay" ], "additionalProperties": false } }, "required": [ "stepType", "config" ], "additionalProperties": false }, { "type": "object", "properties": { "stepType": { "type": "string", "const": "exit" }, "config": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "stepType", "config" ], "additionalProperties": false } ] } } }, "required": [ "name", "triggerType" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "body" ], "additionalProperties": false }, "createFlowResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "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)$" }, "siteId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "description": { "type": "string" }, "triggerType": { "type": "string", "enum": [ "notification_click", "notification_impression", "notification_dismiss", "subscription", "unsubscription" ] }, "triggerCampaignId": { "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": { "type": "string", "enum": [ "draft", "active", "paused", "archived" ] }, "executionCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdBy": { "type": "string" }, "steps": { "type": "array", "items": { "type": "object", "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)$" }, "flowId": { "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)$" }, "stepOrder": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "stepType": { "type": "string", "enum": [ "send_notification", "delay", "exit" ] }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" } }, "required": [ "id", "flowId", "stepOrder", "stepType", "config", "createdAt", "updatedAt" ], "additionalProperties": {} } } }, "required": [ "id", "siteId", "name", "createdAt", "updatedAt", "version", "triggerType", "status", "executionCount", "createdBy", "steps" ], "additionalProperties": {} }, "getFlowInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getFlowResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "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)$" }, "siteId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "description": { "type": "string" }, "triggerType": { "type": "string", "enum": [ "notification_click", "notification_impression", "notification_dismiss", "subscription", "unsubscription" ] }, "triggerCampaignId": { "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": { "type": "string", "enum": [ "draft", "active", "paused", "archived" ] }, "executionCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdBy": { "type": "string" }, "steps": { "type": "array", "items": { "type": "object", "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)$" }, "flowId": { "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)$" }, "stepOrder": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "stepType": { "type": "string", "enum": [ "send_notification", "delay", "exit" ] }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" } }, "required": [ "id", "flowId", "stepOrder", "stepType", "config", "createdAt", "updatedAt" ], "additionalProperties": {} } } }, "required": [ "id", "siteId", "name", "createdAt", "updatedAt", "version", "triggerType", "status", "executionCount", "createdBy", "steps" ], "additionalProperties": {} }, "updateFlowInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "body": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "triggerType": { "type": "string", "enum": [ "notification_click", "notification_impression", "notification_dismiss", "subscription", "unsubscription" ] }, "triggerCampaignId": { "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" } ] }, "steps": { "maxItems": 30, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "stepType": { "type": "string", "const": "send_notification" }, "config": { "type": "object", "properties": { "notification": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 }, "iconUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "imageUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "actionUrl": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "title", "body" ], "additionalProperties": false } }, "required": [ "notification" ], "additionalProperties": false } }, "required": [ "stepType", "config" ], "additionalProperties": false }, { "type": "object", "properties": { "stepType": { "type": "string", "const": "delay" }, "config": { "type": "object", "properties": { "delay": { "type": "object", "properties": { "value": { "type": "integer", "minimum": 1, "maximum": 31536000 }, "unit": { "type": "string", "enum": [ "seconds", "minutes", "hours", "days" ] } }, "required": [ "value", "unit" ], "additionalProperties": false } }, "required": [ "delay" ], "additionalProperties": false } }, "required": [ "stepType", "config" ], "additionalProperties": false }, { "type": "object", "properties": { "stepType": { "type": "string", "const": "exit" }, "config": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "stepType", "config" ], "additionalProperties": false } ] } }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived" ] } }, "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "params", "body" ], "additionalProperties": false }, "updateFlowResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "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)$" }, "siteId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "description": { "type": "string" }, "triggerType": { "type": "string", "enum": [ "notification_click", "notification_impression", "notification_dismiss", "subscription", "unsubscription" ] }, "triggerCampaignId": { "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": { "type": "string", "enum": [ "draft", "active", "paused", "archived" ] }, "executionCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdBy": { "type": "string" }, "steps": { "type": "array", "items": { "type": "object", "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)$" }, "flowId": { "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)$" }, "stepOrder": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "stepType": { "type": "string", "enum": [ "send_notification", "delay", "exit" ] }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" } }, "required": [ "id", "flowId", "stepOrder", "stepType", "config", "createdAt", "updatedAt" ], "additionalProperties": {} } } }, "required": [ "id", "siteId", "name", "createdAt", "updatedAt", "version", "triggerType", "status", "executionCount", "createdBy", "steps" ], "additionalProperties": {} }, "deleteFlowInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getFlowHistoryInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "query": { "type": "object", "properties": { "limit": { "default": 30, "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 3000 }, "status": { "type": "string", "maxLength": 30 } }, "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getFlowHistoryResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "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)$" }, "event": { "type": "string" }, "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)))$" }, "requestId": { "type": "string" }, "connectionId": { "type": "string" }, "snapshot": {} }, "required": [ "id", "event", "at", "requestId", "connectionId", "snapshot" ], "additionalProperties": {} } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": "string" } }, "required": [ "data", "hasMore" ], "additionalProperties": {} }, "activateFlowInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "activateFlowResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "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)$" }, "siteId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "description": { "type": "string" }, "triggerType": { "type": "string", "enum": [ "notification_click", "notification_impression", "notification_dismiss", "subscription", "unsubscription" ] }, "triggerCampaignId": { "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": { "type": "string", "enum": [ "draft", "active", "paused", "archived" ] }, "executionCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdBy": { "type": "string" }, "steps": { "type": "array", "items": { "type": "object", "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)$" }, "flowId": { "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)$" }, "stepOrder": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "stepType": { "type": "string", "enum": [ "send_notification", "delay", "exit" ] }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" } }, "required": [ "id", "flowId", "stepOrder", "stepType", "config", "createdAt", "updatedAt" ], "additionalProperties": {} } } }, "required": [ "id", "siteId", "name", "createdAt", "updatedAt", "version", "triggerType", "status", "executionCount", "createdBy", "steps" ], "additionalProperties": {} }, "pauseFlowInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "pauseFlowResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "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)$" }, "siteId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "description": { "type": "string" }, "triggerType": { "type": "string", "enum": [ "notification_click", "notification_impression", "notification_dismiss", "subscription", "unsubscription" ] }, "triggerCampaignId": { "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": { "type": "string", "enum": [ "draft", "active", "paused", "archived" ] }, "executionCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdBy": { "type": "string" }, "steps": { "type": "array", "items": { "type": "object", "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)$" }, "flowId": { "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)$" }, "stepOrder": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "stepType": { "type": "string", "enum": [ "send_notification", "delay", "exit" ] }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" } }, "required": [ "id", "flowId", "stepOrder", "stepType", "config", "createdAt", "updatedAt" ], "additionalProperties": {} } } }, "required": [ "id", "siteId", "name", "createdAt", "updatedAt", "version", "triggerType", "status", "executionCount", "createdBy", "steps" ], "additionalProperties": {} }, "listFlowRunsInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "query": { "type": "object", "properties": { "limit": { "default": 30, "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 3000 }, "status": { "type": "string", "maxLength": 30 } }, "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "listFlowRunsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "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)$" }, "flowId": { "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)$" }, "eventId": { "type": "string" }, "subscriberId": { "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": { "type": "string", "enum": [ "waiting", "completed", "failed", "suppressed" ] }, "step": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextAt": { "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" } ] }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "errorCode": { "type": [ "string", "null" ] }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" } }, "required": [ "id", "flowId", "eventId", "subscriberId", "status", "step", "nextAt", "attempts", "errorCode", "createdAt", "updatedAt" ], "additionalProperties": {} } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": "string" } }, "required": [ "data", "hasMore" ], "additionalProperties": {} }, "retryFlowRunInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "body": { "type": "object", "properties": { "runId": { "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)$" } }, "required": [ "runId" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "params", "body" ], "additionalProperties": false }, "retryFlowRunResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "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)$" }, "flowId": { "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)$" }, "eventId": { "type": "string" }, "subscriberId": { "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": { "type": "string", "enum": [ "waiting", "completed", "failed", "suppressed" ] }, "step": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextAt": { "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" } ] }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "errorCode": { "type": [ "string", "null" ] }, "createdAt": { "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)))$" }, "updatedAt": { "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)))$" } }, "required": [ "id", "flowId", "eventId", "subscriberId", "status", "step", "nextAt", "attempts", "errorCode", "createdAt", "updatedAt" ], "additionalProperties": {} }, "getIdentityInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {}, "additionalProperties": false }, "getIdentityResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "key_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)$" }, "key_prefix": { "type": "string" }, "key_name": { "type": "string" }, "key_kind": { "type": "string", "enum": [ "server", "bound" ] }, "site": { "type": "object", "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)$" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": {} }, "machine_id": { "type": [ "string", "null" ] }, "created_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)))$" }, "last_used_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" } ] } }, "required": [ "key_id", "key_prefix", "key_name", "key_kind", "site", "machine_id", "created_at", "last_used_at" ], "additionalProperties": {} }, "getSiteInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {}, "additionalProperties": false }, "getSiteResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "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)$" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": {} }, "listChannelsInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {}, "additionalProperties": false }, "listChannelsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "scope": { "type": "string", "enum": [ "account", "recipient" ] }, "owner": { "type": [ "string", "null" ] }, "app": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "reachable": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "total", "reachable" ], "additionalProperties": {} }, "web": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "reachable": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phone": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "total", "reachable", "phone" ], "additionalProperties": {} }, "email": { "type": "object", "properties": { "reachable": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "reachable" ], "additionalProperties": {} }, "slack": { "type": "object", "properties": { "reachable": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "reachable" ], "additionalProperties": {} }, "reachable": { "type": "boolean" }, "phone_reachable": { "type": "boolean" } }, "required": [ "scope", "owner", "app", "web", "email", "slack", "reachable", "phone_reachable" ], "additionalProperties": {} }, "listMachinesInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {}, "additionalProperties": false }, "listMachinesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "machine_id": { "type": "string" }, "last_seen_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)))$" } }, "required": [ "machine_id", "last_seen_at" ], "additionalProperties": {} } } }, "required": [ "items" ], "additionalProperties": {} }, "listAuthorizationRulesInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "query": { "type": "object", "properties": { "scope_aware": { "type": "string", "enum": [ "1", "true" ] }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "repo_aware": { "type": "string", "enum": [ "1", "true" ] }, "repo_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._/@:+-]{0,199}$" }, "agent": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,31}$" } }, "additionalProperties": false } }, "additionalProperties": false }, "listAuthorizationRulesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" }, "tool_name": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_.:-]{0,99}$" }, "effect": { "type": "string", "enum": [ "allow", "deny", "requires_human" ] }, "enabled": { "type": "boolean" }, "conditions": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "field": { "anyOf": [ { "type": "string", "enum": [ "toolTarget", "actor", "environment", "externalId", "sessionId" ] }, { "type": "string", "pattern": "^parameters\\.[A-Za-z_][A-Za-z0-9_.-]{0,99}$" } ] }, "operator": { "type": "string", "enum": [ "eq", "neq", "lt", "lte", "gt", "gte", "in", "not_in", "prefix" ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "minItems": 1, "maxItems": 30, "type": "array", "items": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] } } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "human": { "type": "object", "properties": { "wait_seconds": { "type": "integer", "minimum": 1, "maximum": 600 }, "timeout_action": { "type": "string", "enum": [ "escalate", "deny" ] } }, "additionalProperties": false }, "agent": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,31}$" }, "repo_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._/@:+-]{0,199}$" }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "scope": { "type": "string", "enum": [ "global", "agent", "repo", "session" ] } }, "required": [ "id", "tool_name", "effect", "conditions" ], "additionalProperties": false } } }, "required": [ "version", "rules" ], "additionalProperties": {} }, "createAuthorizationRuleInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "body": { "type": "object", "properties": { "tool_name": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_.:-]{0,99}$" }, "effect": { "type": "string", "enum": [ "allow", "deny", "requires_human" ] }, "enabled": { "type": "boolean" }, "conditions": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "field": { "anyOf": [ { "type": "string", "enum": [ "toolTarget", "actor", "environment", "externalId", "sessionId" ] }, { "type": "string", "pattern": "^parameters\\.[A-Za-z_][A-Za-z0-9_.-]{0,99}$" } ] }, "operator": { "type": "string", "enum": [ "eq", "neq", "lt", "lte", "gt", "gte", "in", "not_in", "prefix" ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "minItems": 1, "maxItems": 30, "type": "array", "items": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] } } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "human": { "type": "object", "properties": { "wait_seconds": { "type": "integer", "minimum": 1, "maximum": 600 }, "timeout_action": { "type": "string", "enum": [ "escalate", "deny" ] } }, "additionalProperties": false }, "agent": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,31}$" }, "repo_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._/@:+-]{0,199}$" }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "idempotency_key": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "tool_name", "effect" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "body" ], "additionalProperties": false }, "createAuthorizationRuleResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rule": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" }, "tool_name": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_.:-]{0,99}$" }, "effect": { "type": "string", "enum": [ "allow", "deny", "requires_human" ] }, "enabled": { "type": "boolean" }, "conditions": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "field": { "anyOf": [ { "type": "string", "enum": [ "toolTarget", "actor", "environment", "externalId", "sessionId" ] }, { "type": "string", "pattern": "^parameters\\.[A-Za-z_][A-Za-z0-9_.-]{0,99}$" } ] }, "operator": { "type": "string", "enum": [ "eq", "neq", "lt", "lte", "gt", "gte", "in", "not_in", "prefix" ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "minItems": 1, "maxItems": 30, "type": "array", "items": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] } } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "human": { "type": "object", "properties": { "wait_seconds": { "type": "integer", "minimum": 1, "maximum": 600 }, "timeout_action": { "type": "string", "enum": [ "escalate", "deny" ] } }, "additionalProperties": false }, "agent": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,31}$" }, "repo_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._/@:+-]{0,199}$" }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "scope": { "type": "string", "enum": [ "global", "agent", "repo", "session" ] } }, "required": [ "id", "tool_name", "effect", "conditions" ], "additionalProperties": false }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" }, "tool_name": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_.:-]{0,99}$" }, "effect": { "type": "string", "enum": [ "allow", "deny", "requires_human" ] }, "enabled": { "type": "boolean" }, "conditions": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "field": { "anyOf": [ { "type": "string", "enum": [ "toolTarget", "actor", "environment", "externalId", "sessionId" ] }, { "type": "string", "pattern": "^parameters\\.[A-Za-z_][A-Za-z0-9_.-]{0,99}$" } ] }, "operator": { "type": "string", "enum": [ "eq", "neq", "lt", "lte", "gt", "gte", "in", "not_in", "prefix" ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "minItems": 1, "maxItems": 30, "type": "array", "items": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] } } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "human": { "type": "object", "properties": { "wait_seconds": { "type": "integer", "minimum": 1, "maximum": 600 }, "timeout_action": { "type": "string", "enum": [ "escalate", "deny" ] } }, "additionalProperties": false }, "agent": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,31}$" }, "repo_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._/@:+-]{0,199}$" }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "scope": { "type": "string", "enum": [ "global", "agent", "repo", "session" ] } }, "required": [ "id", "tool_name", "effect", "conditions" ], "additionalProperties": false } }, "deleted": { "type": "boolean" } }, "required": [ "version" ], "additionalProperties": {} }, "updateAuthorizationRuleInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[\\w-]{1,64}$" } }, "required": [ "id" ], "additionalProperties": false }, "body": { "type": "object", "properties": { "tool_name": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_.:-]{0,99}$" }, "effect": { "type": "string", "enum": [ "allow", "deny", "requires_human" ] }, "enabled": { "type": "boolean" }, "conditions": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "field": { "anyOf": [ { "type": "string", "enum": [ "toolTarget", "actor", "environment", "externalId", "sessionId" ] }, { "type": "string", "pattern": "^parameters\\.[A-Za-z_][A-Za-z0-9_.-]{0,99}$" } ] }, "operator": { "type": "string", "enum": [ "eq", "neq", "lt", "lte", "gt", "gte", "in", "not_in", "prefix" ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "minItems": 1, "maxItems": 30, "type": "array", "items": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] } } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "human": { "type": "object", "properties": { "wait_seconds": { "type": "integer", "minimum": 1, "maximum": 600 }, "timeout_action": { "type": "string", "enum": [ "escalate", "deny" ] } }, "additionalProperties": false }, "agent": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,31}$" }, "repo_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._/@:+-]{0,199}$" }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "idempotency_key": { "type": "string", "minLength": 1, "maxLength": 200 } }, "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "params", "body" ], "additionalProperties": false }, "updateAuthorizationRuleResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rule": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" }, "tool_name": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_.:-]{0,99}$" }, "effect": { "type": "string", "enum": [ "allow", "deny", "requires_human" ] }, "enabled": { "type": "boolean" }, "conditions": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "field": { "anyOf": [ { "type": "string", "enum": [ "toolTarget", "actor", "environment", "externalId", "sessionId" ] }, { "type": "string", "pattern": "^parameters\\.[A-Za-z_][A-Za-z0-9_.-]{0,99}$" } ] }, "operator": { "type": "string", "enum": [ "eq", "neq", "lt", "lte", "gt", "gte", "in", "not_in", "prefix" ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "minItems": 1, "maxItems": 30, "type": "array", "items": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] } } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "human": { "type": "object", "properties": { "wait_seconds": { "type": "integer", "minimum": 1, "maximum": 600 }, "timeout_action": { "type": "string", "enum": [ "escalate", "deny" ] } }, "additionalProperties": false }, "agent": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,31}$" }, "repo_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._/@:+-]{0,199}$" }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "scope": { "type": "string", "enum": [ "global", "agent", "repo", "session" ] } }, "required": [ "id", "tool_name", "effect", "conditions" ], "additionalProperties": false }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" }, "tool_name": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_.:-]{0,99}$" }, "effect": { "type": "string", "enum": [ "allow", "deny", "requires_human" ] }, "enabled": { "type": "boolean" }, "conditions": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "field": { "anyOf": [ { "type": "string", "enum": [ "toolTarget", "actor", "environment", "externalId", "sessionId" ] }, { "type": "string", "pattern": "^parameters\\.[A-Za-z_][A-Za-z0-9_.-]{0,99}$" } ] }, "operator": { "type": "string", "enum": [ "eq", "neq", "lt", "lte", "gt", "gte", "in", "not_in", "prefix" ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "minItems": 1, "maxItems": 30, "type": "array", "items": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] } } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "human": { "type": "object", "properties": { "wait_seconds": { "type": "integer", "minimum": 1, "maximum": 600 }, "timeout_action": { "type": "string", "enum": [ "escalate", "deny" ] } }, "additionalProperties": false }, "agent": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,31}$" }, "repo_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._/@:+-]{0,199}$" }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "scope": { "type": "string", "enum": [ "global", "agent", "repo", "session" ] } }, "required": [ "id", "tool_name", "effect", "conditions" ], "additionalProperties": false } }, "deleted": { "type": "boolean" } }, "required": [ "version" ], "additionalProperties": {} }, "deleteAuthorizationRuleInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[\\w-]{1,64}$" } }, "required": [ "id" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "deleteAuthorizationRuleResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rule": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" }, "tool_name": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_.:-]{0,99}$" }, "effect": { "type": "string", "enum": [ "allow", "deny", "requires_human" ] }, "enabled": { "type": "boolean" }, "conditions": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "field": { "anyOf": [ { "type": "string", "enum": [ "toolTarget", "actor", "environment", "externalId", "sessionId" ] }, { "type": "string", "pattern": "^parameters\\.[A-Za-z_][A-Za-z0-9_.-]{0,99}$" } ] }, "operator": { "type": "string", "enum": [ "eq", "neq", "lt", "lte", "gt", "gte", "in", "not_in", "prefix" ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "minItems": 1, "maxItems": 30, "type": "array", "items": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] } } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "human": { "type": "object", "properties": { "wait_seconds": { "type": "integer", "minimum": 1, "maximum": 600 }, "timeout_action": { "type": "string", "enum": [ "escalate", "deny" ] } }, "additionalProperties": false }, "agent": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,31}$" }, "repo_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._/@:+-]{0,199}$" }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "scope": { "type": "string", "enum": [ "global", "agent", "repo", "session" ] } }, "required": [ "id", "tool_name", "effect", "conditions" ], "additionalProperties": false }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" }, "tool_name": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_.:-]{0,99}$" }, "effect": { "type": "string", "enum": [ "allow", "deny", "requires_human" ] }, "enabled": { "type": "boolean" }, "conditions": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "field": { "anyOf": [ { "type": "string", "enum": [ "toolTarget", "actor", "environment", "externalId", "sessionId" ] }, { "type": "string", "pattern": "^parameters\\.[A-Za-z_][A-Za-z0-9_.-]{0,99}$" } ] }, "operator": { "type": "string", "enum": [ "eq", "neq", "lt", "lte", "gt", "gte", "in", "not_in", "prefix" ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "minItems": 1, "maxItems": 30, "type": "array", "items": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] } } ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false } }, "human": { "type": "object", "properties": { "wait_seconds": { "type": "integer", "minimum": 1, "maximum": 600 }, "timeout_action": { "type": "string", "enum": [ "escalate", "deny" ] } }, "additionalProperties": false }, "agent": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,31}$" }, "repo_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._/@:+-]{0,199}$" }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "scope": { "type": "string", "enum": [ "global", "agent", "repo", "session" ] } }, "required": [ "id", "tool_name", "effect", "conditions" ], "additionalProperties": false } }, "deleted": { "type": "boolean" } }, "required": [ "version" ], "additionalProperties": {} }, "authorizeActionInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "body": { "type": "object", "properties": { "subject": { "type": "object", "properties": { "tool_name": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_.:-]{0,99}$" }, "tool_target": { "type": "string", "maxLength": 200 }, "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 }, "external_id": { "type": "string", "minLength": 1, "maxLength": 200 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "agent": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,31}$" }, "repo_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._/@:+-]{0,199}$" }, "parameters": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number", "boolean" ] } } }, "required": [ "tool_name" ], "additionalProperties": false }, "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "agent_name": { "type": "string", "maxLength": 100 }, "idempotency_key": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "subject" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "body" ], "additionalProperties": false }, "authorizeActionResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "verdict": { "type": "string", "enum": [ "allow", "deny", "requires_human" ] }, "policy_id": { "type": "string" }, "reason": { "type": "string" }, "authorization_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)$" }, "expires_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)))$" } }, "required": [ "verdict", "reason", "authorization_id", "expires_at" ], "additionalProperties": {} }, "consumeAuthorizationInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "body": { "type": "object", "properties": { "authorization_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)$" }, "subject": { "type": "object", "properties": { "tool_name": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_.:-]{0,99}$" }, "tool_target": { "type": "string", "maxLength": 200 }, "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 }, "external_id": { "type": "string", "minLength": 1, "maxLength": 200 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "agent": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,31}$" }, "repo_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._/@:+-]{0,199}$" }, "parameters": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number", "boolean" ] } } }, "required": [ "tool_name" ], "additionalProperties": false } }, "required": [ "authorization_id", "subject" ], "additionalProperties": false } }, "required": [ "body" ], "additionalProperties": false }, "consumeAuthorizationResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "permit_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)$" }, "authority": { "type": "string" }, "expires_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)))$" } }, "required": [ "permit_id", "authority", "expires_at" ], "additionalProperties": {} }, "recordExecutionReceiptInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "properties": { "permitId": { "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)$" } }, "required": [ "permitId" ], "additionalProperties": false }, "body": { "type": "object", "properties": { "outcome": { "type": "string", "enum": [ "succeeded", "failed", "unknown" ] }, "summary": { "type": "string", "maxLength": 2000 } }, "required": [ "outcome" ], "additionalProperties": false } }, "required": [ "params", "body" ], "additionalProperties": false }, "recordExecutionReceiptResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "permit_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)$" }, "execution_state": { "type": "string", "enum": [ "succeeded", "failed", "unknown" ] }, "conflict": { "type": "boolean" } }, "required": [ "permit_id", "execution_state", "conflict" ], "additionalProperties": {} }, "listSubscribersInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "query": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 4096 }, "status": { "type": "string", "enum": [ "active", "unsubscribed", "expired", "bounced" ] }, "external_id": { "type": "string" }, "tags": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "listSubscribersResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "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)$" }, "siteId": { "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)$" }, "endpoint": { "type": "string", "format": "uri" }, "status": { "type": "string", "enum": [ "active", "unsubscribed", "expired", "bounced" ] }, "browser": { "type": "string", "minLength": 1, "maxLength": 40 }, "os": { "type": "string", "minLength": 1, "maxLength": 40 }, "deviceType": { "type": "string", "enum": [ "mobile", "tablet", "desktop" ] }, "country": { "type": "string", "pattern": "^[A-Z]{2}$" }, "city": { "type": "string", "minLength": 1, "maxLength": 120 }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "language": { "type": "string", "minLength": 1, "maxLength": 60 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "externalId": { "type": "string" }, "customData": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/listSubscribersResponse/$defs/__schema0" } }, "createdAt": { "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))$" }, "lastActiveAt": { "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))$" } }, "required": [ "id", "siteId", "endpoint", "status", "tags", "createdAt" ], "additionalProperties": {} } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": "string" } }, "required": [ "data", "hasMore" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/listSubscribersResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/listSubscribersResponse/$defs/__schema0" } } ] } } }, "countSubscribersInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {}, "additionalProperties": false }, "countSubscribersResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "active": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unsubscribed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "expired": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "total", "active", "unsubscribed", "expired", "bounced" ], "additionalProperties": {} }, "getSubscriberInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "properties": { "subscriberId": { "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)$" } }, "required": [ "subscriberId" ], "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getSubscriberResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "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)$" }, "siteId": { "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)$" }, "endpoint": { "type": "string", "format": "uri" }, "status": { "type": "string", "enum": [ "active", "unsubscribed", "expired", "bounced" ] }, "browser": { "type": "string", "minLength": 1, "maxLength": 40 }, "os": { "type": "string", "minLength": 1, "maxLength": 40 }, "deviceType": { "type": "string", "enum": [ "mobile", "tablet", "desktop" ] }, "country": { "type": "string", "pattern": "^[A-Z]{2}$" }, "city": { "type": "string", "minLength": 1, "maxLength": 120 }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "language": { "type": "string", "minLength": 1, "maxLength": 60 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "externalId": { "type": "string" }, "customData": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/getSubscriberResponse/$defs/__schema0" } }, "createdAt": { "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))$" }, "lastActiveAt": { "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))$" } }, "required": [ "id", "siteId", "endpoint", "status", "tags", "createdAt" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/getSubscriberResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/getSubscriberResponse/$defs/__schema0" } } ] } } }, "updateSubscriberInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "properties": { "subscriberId": { "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)$" } }, "required": [ "subscriberId" ], "additionalProperties": false }, "body": { "type": "object", "properties": { "external_id": { "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "type": "string" } }, "custom_data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "additionalProperties": false } }, "required": [ "params", "body" ], "additionalProperties": false }, "updateSubscriberResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "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)$" }, "siteId": { "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)$" }, "endpoint": { "type": "string", "format": "uri" }, "status": { "type": "string", "enum": [ "active", "unsubscribed", "expired", "bounced" ] }, "browser": { "type": "string", "minLength": 1, "maxLength": 40 }, "os": { "type": "string", "minLength": 1, "maxLength": 40 }, "deviceType": { "type": "string", "enum": [ "mobile", "tablet", "desktop" ] }, "country": { "type": "string", "pattern": "^[A-Z]{2}$" }, "city": { "type": "string", "minLength": 1, "maxLength": 120 }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "language": { "type": "string", "minLength": 1, "maxLength": 60 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "externalId": { "type": "string" }, "customData": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/updateSubscriberResponse/$defs/__schema0" } }, "createdAt": { "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))$" }, "lastActiveAt": { "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))$" } }, "required": [ "id", "siteId", "endpoint", "status", "tags", "createdAt" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/updateSubscriberResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/updateSubscriberResponse/$defs/__schema0" } } ] } } }, "deleteSubscriberInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "properties": { "subscriberId": { "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)$" } }, "required": [ "subscriberId" ], "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "sendPushInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "body": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 }, "templateId": { "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)$" }, "variables": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_.-]{0,39}$" }, "additionalProperties": { "type": "string", "maxLength": 500 } }, "iconUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "imageUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "subscriberIds": { "minItems": 1, "maxItems": 100, "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)$" } }, "externalIds": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/sendPushInput/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/sendPushInput/$defs/__schema0" } }, "idempotencyKey": { "type": "string", "minLength": 1, "maxLength": 200 } }, "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 } }, "additionalProperties": false } }, "required": [ "body" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/sendPushInput/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/sendPushInput/$defs/__schema0" } } ] } } }, "sendPushResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "notificationId": { "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": { "type": "string", "const": "queued" }, "queued": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "duplicate": { "type": "boolean" }, "limits": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "window": { "type": "string", "const": "utc_day" }, "resetsAt": { "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))$" } }, "required": [ "limit", "remaining", "window", "resetsAt" ], "additionalProperties": {} } }, "required": [ "success", "notificationId", "status", "queued", "duplicate", "limits" ], "additionalProperties": {} }, "getNotificationInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "properties": { "notificationId": { "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)$" } }, "required": [ "notificationId" ], "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getNotificationResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "notificationId": { "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)$" }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "cancelled", "expired" ] }, "createdAt": { "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)))$" }, "detailUrl": { "type": "string", "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "iconUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "imageUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/getNotificationResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/getNotificationResponse/$defs/__schema0" } }, "limits": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "window": { "type": "string", "const": "utc_day" }, "resetsAt": { "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))$" } }, "required": [ "limit", "remaining", "window", "resetsAt" ], "additionalProperties": {} }, "delivery": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "queued", "accepted", "partial", "failed", "unreachable", "cancelled" ] }, "selected": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "queued": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "accepted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "failed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "suppressed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "status", "selected", "queued", "accepted", "failed", "suppressed" ], "additionalProperties": false } }, "required": [ "notificationId", "title", "body", "status", "createdAt", "detailUrl", "limits", "delivery" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/getNotificationResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/getNotificationResponse/$defs/__schema0" } } ] } } }, "getWebhookSecretInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {}, "additionalProperties": false }, "getWebhookSecretResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "webhookSecret": { "type": "string", "minLength": 1 }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "webhookSecret", "version" ], "additionalProperties": {} }, "rotateWebhookSecretInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\"\\d+\"$" } }, "additionalProperties": false } }, "additionalProperties": false }, "rotateWebhookSecretResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "webhookSecret": { "type": "string", "minLength": 1 }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "webhookSecret", "version" ], "additionalProperties": {} }, "createDecisionInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "body": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "context": { "type": "string", "maxLength": 10000 }, "placeholder": { "type": "string", "maxLength": 500 }, "agent_name": { "type": "string", "maxLength": 100 }, "callback_url": { "type": "string", "format": "uri" }, "options": { "minItems": 2, "maxItems": 10, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "subject": { "type": "object", "properties": { "tool_name": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_.:-]{0,99}$" }, "tool_target": { "type": "string", "maxLength": 200 }, "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 }, "external_id": { "type": "string", "minLength": 1, "maxLength": 200 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "agent": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,31}$" }, "repo_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._/@:+-]{0,199}$" }, "parameters": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number", "boolean" ] } } }, "required": [ "tool_name" ], "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "expires_in_seconds": { "type": "integer", "minimum": 60, "maximum": 86400 }, "require_reachable": { "type": "boolean" }, "approval_url": { "type": "boolean" }, "powered_by": { "type": "boolean" }, "idempotency_key": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "question", "subject" ], "additionalProperties": false }, "headers": { "type": "object", "properties": { "Idempotency-Key": { "type": "string", "minLength": 1, "maxLength": 200 }, "If-Match": { "type": "string", "pattern": "^\\d+$" } }, "additionalProperties": false } }, "required": [ "body" ], "additionalProperties": false }, "createDecisionResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "type": "object", "properties": { "decision_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)$" }, "task": { "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createDecisionResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createDecisionResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {} }, "approval_url": { "type": "string" }, "idempotent": { "type": "boolean" }, "availability": { "type": "object", "properties": { "web_endpoints": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "email_channels": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "slack_connections": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "web_endpoints", "email_channels", "slack_connections" ], "additionalProperties": {} }, "status": { "type": "string", "const": "answered" }, "answered": { "type": "boolean", "const": true }, "value": { "type": "string" } }, "required": [ "decision_id", "task", "idempotent", "availability", "status", "answered", "value" ], "additionalProperties": {} }, { "type": "object", "properties": { "decision_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)$" }, "task": { "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createDecisionResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createDecisionResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {} }, "approval_url": { "type": "string" }, "idempotent": { "type": "boolean" }, "availability": { "type": "object", "properties": { "web_endpoints": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "email_channels": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "slack_connections": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "web_endpoints", "email_channels", "slack_connections" ], "additionalProperties": {} }, "status": { "type": "string", "enum": [ "pending", "cancelled", "expired" ] }, "answered": { "type": "boolean", "const": false }, "value": { "type": "null" } }, "required": [ "decision_id", "task", "idempotent", "availability", "status", "answered", "value" ], "additionalProperties": {} }, { "type": "object", "properties": { "status": { "type": "string", "const": "stopped" }, "answered": { "type": "boolean", "const": false }, "value": { "type": "null" }, "idempotent": { "type": "boolean" }, "stopped": { "type": "object", "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)$" }, "site_epoch": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "session_epoch": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "type": "string", "enum": [ "site", "session" ] } }, "required": [ "id", "site_epoch", "session_epoch", "scope" ], "additionalProperties": {} } }, "required": [ "status", "answered", "value", "idempotent", "stopped" ], "additionalProperties": {} } ], "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/createDecisionResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/createDecisionResponse/$defs/__schema0" } } ] } } }, "previewApprovalLinkInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "properties": { "owner": { "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)$" }, "decisionId": { "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)$" } }, "required": [ "owner", "decisionId" ], "additionalProperties": false }, "body": { "type": "object", "properties": { "token": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "token" ], "additionalProperties": false } }, "required": [ "params", "body" ], "additionalProperties": false }, "previewApprovalLinkResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "can_answer": { "type": "boolean" }, "task": { "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/previewApprovalLinkResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/previewApprovalLinkResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {} }, "recipient": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": {} }, "sender": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": {} }, "expires_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)))$" }, "powered_by": { "type": "boolean" } }, "required": [ "can_answer", "task", "recipient", "sender", "expires_at", "powered_by" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/previewApprovalLinkResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/previewApprovalLinkResponse/$defs/__schema0" } } ] } } }, "answerApprovalLinkInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "properties": { "owner": { "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)$" }, "decisionId": { "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)$" } }, "required": [ "owner", "decisionId" ], "additionalProperties": false }, "body": { "type": "object", "properties": { "token": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "answer": { "type": "string", "minLength": 1, "maxLength": 4000 }, "idempotency_key": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "token", "answer", "idempotency_key" ], "additionalProperties": false } }, "required": [ "params", "body" ], "additionalProperties": false }, "answerApprovalLinkResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "can_answer": { "type": "boolean" }, "task": { "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/answerApprovalLinkResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/answerApprovalLinkResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {} }, "recipient": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": {} }, "sender": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": {} }, "expires_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)))$" }, "powered_by": { "type": "boolean" } }, "required": [ "can_answer", "task", "recipient", "sender", "expires_at", "powered_by" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/answerApprovalLinkResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/answerApprovalLinkResponse/$defs/__schema0" } } ] } } }, "revokeApprovalLinkInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "properties": { "decisionId": { "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)$" } }, "required": [ "decisionId" ], "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "revokeApprovalLinkResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": {} }, "getDecisionInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "properties": { "decisionId": { "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)$" } }, "required": [ "decisionId" ], "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getDecisionResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "type": "object", "properties": { "decision_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)$" }, "task": { "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/getDecisionResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/getDecisionResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {} }, "approval_url": { "type": "string" }, "idempotent": { "type": "boolean" }, "availability": { "type": "object", "properties": { "web_endpoints": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "email_channels": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "slack_connections": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "web_endpoints", "email_channels", "slack_connections" ], "additionalProperties": {} }, "status": { "type": "string", "const": "answered" }, "answered": { "type": "boolean", "const": true }, "value": { "type": "string" } }, "required": [ "decision_id", "task", "idempotent", "availability", "status", "answered", "value" ], "additionalProperties": {} }, { "type": "object", "properties": { "decision_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)$" }, "task": { "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/getDecisionResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/getDecisionResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {} }, "approval_url": { "type": "string" }, "idempotent": { "type": "boolean" }, "availability": { "type": "object", "properties": { "web_endpoints": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "email_channels": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "slack_connections": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "web_endpoints", "email_channels", "slack_connections" ], "additionalProperties": {} }, "status": { "type": "string", "enum": [ "pending", "cancelled", "expired" ] }, "answered": { "type": "boolean", "const": false }, "value": { "type": "null" } }, "required": [ "decision_id", "task", "idempotent", "availability", "status", "answered", "value" ], "additionalProperties": {} }, { "type": "object", "properties": { "status": { "type": "string", "const": "stopped" }, "answered": { "type": "boolean", "const": false }, "value": { "type": "null" }, "idempotent": { "type": "boolean" }, "stopped": { "type": "object", "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)$" }, "site_epoch": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "session_epoch": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "type": "string", "enum": [ "site", "session" ] } }, "required": [ "id", "site_epoch", "session_epoch", "scope" ], "additionalProperties": {} } }, "required": [ "status", "answered", "value", "idempotent", "stopped" ], "additionalProperties": {} } ], "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/getDecisionResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/getDecisionResponse/$defs/__schema0" } } ] } } }, "answerDecisionInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "properties": { "decisionId": { "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)$" } }, "required": [ "decisionId" ], "additionalProperties": false }, "body": { "type": "object", "properties": { "answer": { "type": "string", "minLength": 1, "maxLength": 4000 }, "idempotency_key": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "answer", "idempotency_key" ], "additionalProperties": false } }, "required": [ "params", "body" ], "additionalProperties": false }, "answerDecisionResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "type": "object", "properties": { "decision_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)$" }, "task": { "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/answerDecisionResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/answerDecisionResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {} }, "approval_url": { "type": "string" }, "idempotent": { "type": "boolean" }, "availability": { "type": "object", "properties": { "web_endpoints": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "email_channels": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "slack_connections": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "web_endpoints", "email_channels", "slack_connections" ], "additionalProperties": {} }, "status": { "type": "string", "const": "answered" }, "answered": { "type": "boolean", "const": true }, "value": { "type": "string" } }, "required": [ "decision_id", "task", "idempotent", "availability", "status", "answered", "value" ], "additionalProperties": {} }, { "type": "object", "properties": { "decision_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)$" }, "task": { "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/answerDecisionResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/answerDecisionResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {} }, "approval_url": { "type": "string" }, "idempotent": { "type": "boolean" }, "availability": { "type": "object", "properties": { "web_endpoints": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "email_channels": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "slack_connections": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "web_endpoints", "email_channels", "slack_connections" ], "additionalProperties": {} }, "status": { "type": "string", "enum": [ "pending", "cancelled", "expired" ] }, "answered": { "type": "boolean", "const": false }, "value": { "type": "null" } }, "required": [ "decision_id", "task", "idempotent", "availability", "status", "answered", "value" ], "additionalProperties": {} }, { "type": "object", "properties": { "status": { "type": "string", "const": "stopped" }, "answered": { "type": "boolean", "const": false }, "value": { "type": "null" }, "idempotent": { "type": "boolean" }, "stopped": { "type": "object", "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)$" }, "site_epoch": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "session_epoch": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "type": "string", "enum": [ "site", "session" ] } }, "required": [ "id", "site_epoch", "session_epoch", "scope" ], "additionalProperties": {} } }, "required": [ "status", "answered", "value", "idempotent", "stopped" ], "additionalProperties": {} } ], "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/answerDecisionResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/answerDecisionResponse/$defs/__schema0" } } ] } } }, "cancelDecisionInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "properties": { "decisionId": { "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)$" } }, "required": [ "decisionId" ], "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "cancelDecisionResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "type": "object", "properties": { "decision_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)$" }, "task": { "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/cancelDecisionResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/cancelDecisionResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {} }, "approval_url": { "type": "string" }, "idempotent": { "type": "boolean" }, "availability": { "type": "object", "properties": { "web_endpoints": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "email_channels": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "slack_connections": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "web_endpoints", "email_channels", "slack_connections" ], "additionalProperties": {} }, "status": { "type": "string", "const": "answered" }, "answered": { "type": "boolean", "const": true }, "value": { "type": "string" } }, "required": [ "decision_id", "task", "idempotent", "availability", "status", "answered", "value" ], "additionalProperties": {} }, { "type": "object", "properties": { "decision_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)$" }, "task": { "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/cancelDecisionResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/cancelDecisionResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {} }, "approval_url": { "type": "string" }, "idempotent": { "type": "boolean" }, "availability": { "type": "object", "properties": { "web_endpoints": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "email_channels": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "slack_connections": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "web_endpoints", "email_channels", "slack_connections" ], "additionalProperties": {} }, "status": { "type": "string", "enum": [ "pending", "cancelled", "expired" ] }, "answered": { "type": "boolean", "const": false }, "value": { "type": "null" } }, "required": [ "decision_id", "task", "idempotent", "availability", "status", "answered", "value" ], "additionalProperties": {} }, { "type": "object", "properties": { "status": { "type": "string", "const": "stopped" }, "answered": { "type": "boolean", "const": false }, "value": { "type": "null" }, "idempotent": { "type": "boolean" }, "stopped": { "type": "object", "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)$" }, "site_epoch": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "session_epoch": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "type": "string", "enum": [ "site", "session" ] } }, "required": [ "id", "site_epoch", "session_epoch", "scope" ], "additionalProperties": {} } }, "required": [ "status", "answered", "value", "idempotent", "stopped" ], "additionalProperties": {} } ], "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/cancelDecisionResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/cancelDecisionResponse/$defs/__schema0" } } ] } } }, "enrollRecipientInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "body": { "type": "object", "properties": { "external_id": { "type": "string", "minLength": 1, "maxLength": 200 }, "idempotency_key": { "type": "string", "pattern": "^[\\w.-]{8,100}$" } }, "required": [ "external_id", "idempotency_key" ], "additionalProperties": false } }, "required": [ "body" ], "additionalProperties": false }, "enrollRecipientResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "externalId": { "type": "string" }, "recipientId": { "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)$" }, "token": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "universalLink": { "type": "string", "format": "uri" }, "deepLink": { "type": "string", "format": "uri" }, "expiresInSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "enrollmentMode": { "type": "string", "const": "link" }, "alreadyEnrolled": { "type": "boolean" }, "idempotent": { "type": "boolean" } }, "required": [ "externalId", "recipientId", "token", "universalLink", "deepLink", "expiresInSeconds", "enrollmentMode", "alreadyEnrolled", "idempotent" ], "additionalProperties": {} }, "issueBoundKeyInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "body": { "type": "object", "properties": { "kind": { "type": "string", "const": "bound" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "client": { "type": "string" }, "parent_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)$" }, "recipient_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)$" }, "external_id": { "type": "string", "minLength": 1, "maxLength": 200 }, "expires_in_seconds": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "idempotency_key": { "type": "string", "pattern": "^[\\w.-]{8,100}$" } }, "required": [ "kind", "name", "idempotency_key" ], "additionalProperties": false } }, "required": [ "body" ], "additionalProperties": false }, "issueBoundKeyResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "key": { "type": "object", "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)$" }, "key_prefix": { "type": "string", "pattern": "^nk_[0-9a-f-]{36}$" }, "kind": { "type": "string", "enum": [ "manual_connection", "oauth_access", "server", "bound" ] }, "name": { "type": "string" }, "client": { "type": "string" }, "parent_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)$" }, "recipient_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)$" }, "external_id": { "type": "string" }, "active": { "type": "boolean" }, "created_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)))$" }, "expires_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" } ] }, "revoked_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" } ] }, "last_used_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" } ] } }, "required": [ "id", "key_prefix", "kind", "name", "client", "active", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": {} }, "token": { "type": "string" } }, "required": [ "key", "token" ], "additionalProperties": {} }, "listBoundKeysInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {}, "additionalProperties": false }, "listBoundKeysResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "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)$" }, "key_prefix": { "type": "string", "pattern": "^nk_[0-9a-f-]{36}$" }, "kind": { "type": "string", "enum": [ "manual_connection", "oauth_access", "server", "bound" ] }, "name": { "type": "string" }, "client": { "type": "string" }, "parent_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)$" }, "recipient_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)$" }, "external_id": { "type": "string" }, "active": { "type": "boolean" }, "created_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)))$" }, "expires_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" } ] }, "revoked_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" } ] }, "last_used_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" } ] } }, "required": [ "id", "key_prefix", "kind", "name", "client", "active", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": {} } } }, "required": [ "items" ], "additionalProperties": {} }, "revokeBoundKeyInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "revokeBoundKeyResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "key_prefix": { "type": "string" }, "revoked": { "type": "boolean" } }, "required": [ "key_prefix", "revoked" ], "additionalProperties": {} }, "revokeCurrentKeyInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {}, "additionalProperties": false }, "revokeCurrentKeyResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "key_prefix": { "type": "string" }, "revoked": { "type": "boolean" } }, "required": [ "key_prefix", "revoked" ], "additionalProperties": {} }, "getReachabilityInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "query": { "type": "object", "properties": { "external_id": { "type": "string", "minLength": 1, "maxLength": 200 } }, "additionalProperties": false } }, "additionalProperties": false }, "getReachabilityResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "externalId": { "type": "string" }, "deliverability": { "type": "string", "enum": [ "invited", "active", "revoked" ] }, "reachable": { "type": "boolean" }, "reachableChannels": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "deviceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "webEndpoints": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "externalId", "deliverability", "reachable", "reachableChannels", "deviceCount", "webEndpoints" ], "additionalProperties": {} }, "createTaskInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "body": { "anyOf": [ { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "idempotency_key": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[\\w.-]+$" }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createTaskInput/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createTaskInput/$defs/__schema0" } }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question" ], "additionalProperties": false }, "expires_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)))$" }, "kind": { "type": "string", "const": "notification" } }, "required": [ "title", "idempotency_key", "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "idempotency_key": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[\\w.-]+$" }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createTaskInput/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createTaskInput/$defs/__schema0" } }, "delay_seconds": { "type": "integer", "minimum": 1, "maximum": 31536000 }, "run_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)))$" }, "snooze_seconds": { "default": 600, "type": "integer", "minimum": 1, "maximum": 604800 }, "kind": { "type": "string", "const": "reminder" } }, "required": [ "title", "idempotency_key", "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createTaskInput/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createTaskInput/$defs/__schema0" } }, "kind": { "type": "string", "const": "question" }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question" ], "additionalProperties": false }, "expires_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)))$" }, "idempotency_key": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[\\w.-]+$" } }, "required": [ "kind", "interaction", "expires_at", "idempotency_key" ], "additionalProperties": false } ] } }, "required": [ "body" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/createTaskInput/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/createTaskInput/$defs/__schema0" } } ] } } }, "createTaskResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createTaskResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createTaskResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/createTaskResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/createTaskResponse/$defs/__schema0" } } ] } } }, "listTasksInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "query": { "type": "object", "properties": { "cursor": { "type": "string", "minLength": 1, "maxLength": 4096 }, "status": { "type": "string", "enum": [ "pending", "ended" ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "machine_id": { "type": "string" }, "schedule_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 } }, "additionalProperties": false }, "listTasksResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/listTasksResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/listTasksResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/listTasksResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/listTasksResponse/$defs/__schema0" } } ] } } }, "getTaskInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getTaskResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/getTaskResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/getTaskResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/getTaskResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/getTaskResponse/$defs/__schema0" } } ] } } }, "respondToTaskInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "body": { "type": "object", "properties": { "occurrence_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)$" }, "action_id": { "type": "string", "minLength": 1, "maxLength": 60 }, "expected_version": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "idempotency_key": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[\\w.-]+$" }, "verification_token": { "type": "string", "maxLength": 100 }, "value": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 40 } }, { "type": "boolean" } ] }, "other": { "type": "string", "minLength": 1, "maxLength": 2000 }, "note": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "occurrence_id", "action_id", "expected_version", "idempotency_key" ], "additionalProperties": false } }, "required": [ "params", "body" ], "additionalProperties": false }, "respondToTaskResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/respondToTaskResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/respondToTaskResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/respondToTaskResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/respondToTaskResponse/$defs/__schema0" } } ] } } }, "cancelTaskInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "body": { "type": "object", "properties": { "expected_version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "cancelTaskResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/cancelTaskResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/cancelTaskResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/cancelTaskResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/cancelTaskResponse/$defs/__schema0" } } ] } } }, "handoffQuestionInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "handoffQuestionResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "handoff_action": { "type": "string", "enum": [ "ask_in_current_client", "use_response", "stop" ] }, "task": { "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/handoffQuestionResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/handoffQuestionResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {} } }, "required": [ "handoff_action", "task" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/handoffQuestionResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/handoffQuestionResponse/$defs/__schema0" } } ] } } }, "waitForResponseInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "body": { "type": "object", "properties": { "timeout_seconds": { "default": 20, "type": "integer", "minimum": 1, "maximum": 25 }, "on_timeout": { "type": "string", "enum": [ "retain", "handoff" ] } }, "additionalProperties": false } }, "required": [ "params", "body" ], "additionalProperties": false }, "waitForResponseResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "task_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)$" }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "task": { "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/waitForResponseResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/waitForResponseResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {} }, "handoff_action": { "type": "string", "enum": [ "ask_in_current_client", "use_response", "stop" ] } }, "required": [ "status", "task_id", "response", "task" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/waitForResponseResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/waitForResponseResponse/$defs/__schema0" } } ] } } }, "createScheduleInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "body": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "recurring" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createScheduleInput/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createScheduleInput/$defs/__schema0" } }, "rule": { "oneOf": [ { "type": "object", "properties": { "frequency": { "type": "string", "const": "interval" }, "every_seconds": { "type": "integer", "minimum": 60, "maximum": 31536000 } }, "required": [ "frequency", "every_seconds" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "daily" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "frequency", "timezone", "time" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "weekly" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" }, "weekdays": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } } }, "required": [ "frequency", "timezone", "time", "weekdays" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "monthly" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" }, "day": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 31 }, { "type": "string", "const": "last" } ] } }, "required": [ "frequency", "timezone", "time", "day" ], "additionalProperties": false } ] }, "start_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)))$" }, "end_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)))$" }, "max_occurrences": { "type": "integer", "minimum": 1, "maximum": 100000 }, "snooze_seconds": { "default": 600, "type": "integer", "minimum": 1, "maximum": 604800 }, "idempotency_key": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[\\w.-]+$" } }, "required": [ "kind", "title", "rule", "idempotency_key" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "pomodoro" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createScheduleInput/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createScheduleInput/$defs/__schema0" } }, "work_seconds": { "default": 1500, "type": "integer", "minimum": 1, "maximum": 86400 }, "short_break_seconds": { "default": 300, "type": "integer", "minimum": 1, "maximum": 86400 }, "long_break_seconds": { "default": 900, "type": "integer", "minimum": 1, "maximum": 86400 }, "long_break_every": { "default": 4, "type": "integer", "minimum": 1, "maximum": 12 }, "total_cycles": { "default": 4, "type": "integer", "minimum": 1, "maximum": 48 }, "auto_advance": { "default": false, "type": "boolean" }, "idempotency_key": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[\\w.-]+$" } }, "required": [ "kind", "title", "idempotency_key" ], "additionalProperties": false } ] } }, "required": [ "body" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/createScheduleInput/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/createScheduleInput/$defs/__schema0" } } ] } } }, "createScheduleResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "schedule_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", "enum": [ "recurring", "pomodoro" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "definition": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "recurring" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createScheduleResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createScheduleResponse/$defs/__schema0" } }, "rule": { "oneOf": [ { "type": "object", "properties": { "frequency": { "type": "string", "const": "interval" }, "every_seconds": { "type": "integer", "minimum": 60, "maximum": 31536000 } }, "required": [ "frequency", "every_seconds" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "daily" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "frequency", "timezone", "time" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "weekly" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" }, "weekdays": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } } }, "required": [ "frequency", "timezone", "time", "weekdays" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "monthly" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" }, "day": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 31 }, { "type": "string", "const": "last" } ] } }, "required": [ "frequency", "timezone", "time", "day" ], "additionalProperties": false } ] }, "start_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)))$" }, "end_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)))$" }, "max_occurrences": { "type": "integer", "minimum": 1, "maximum": 100000 }, "snooze_seconds": { "default": 600, "type": "integer", "minimum": 1, "maximum": 604800 } }, "required": [ "kind", "title", "body", "rule", "snooze_seconds" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "pomodoro" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createScheduleResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/createScheduleResponse/$defs/__schema0" } }, "work_seconds": { "default": 1500, "type": "integer", "minimum": 1, "maximum": 86400 }, "short_break_seconds": { "default": 300, "type": "integer", "minimum": 1, "maximum": 86400 }, "long_break_seconds": { "default": 900, "type": "integer", "minimum": 1, "maximum": 86400 }, "long_break_every": { "default": 4, "type": "integer", "minimum": 1, "maximum": 12 }, "total_cycles": { "default": 4, "type": "integer", "minimum": 1, "maximum": 48 }, "auto_advance": { "default": false, "type": "boolean" } }, "required": [ "kind", "title", "body", "work_seconds", "short_break_seconds", "long_break_seconds", "long_break_every", "total_cycles", "auto_advance" ], "additionalProperties": false } ] }, "status": { "type": "string", "enum": [ "active", "paused", "completed", "cancelled" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "next_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" } ] }, "remaining_seconds": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "phase": { "anyOf": [ { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, { "type": "null" } ] }, "pause_reason": { "anyOf": [ { "type": "string", "enum": [ "user", "stage_end", "capacity" ] }, { "type": "null" } ] }, "completed_cycles": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "occurrence_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "connection_id": { "type": "string" }, "client_type": { "type": "string" }, "current_task_id": { "type": [ "string", "null" ] }, "created_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)))$" }, "updated_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)))$" } }, "required": [ "schedule_id", "kind", "title", "body", "definition", "status", "version", "next_at", "remaining_seconds", "phase", "pause_reason", "completed_cycles", "occurrence_count", "source", "connection_id", "client_type", "current_task_id", "created_at", "updated_at" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/createScheduleResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/createScheduleResponse/$defs/__schema0" } } ] } } }, "listSchedulesInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "query": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 4096 }, "status": { "type": "string", "enum": [ "active", "paused", "completed", "cancelled" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "listSchedulesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "schedule_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", "enum": [ "recurring", "pomodoro" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "definition": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "recurring" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/listSchedulesResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/listSchedulesResponse/$defs/__schema0" } }, "rule": { "oneOf": [ { "type": "object", "properties": { "frequency": { "type": "string", "const": "interval" }, "every_seconds": { "type": "integer", "minimum": 60, "maximum": 31536000 } }, "required": [ "frequency", "every_seconds" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "daily" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "frequency", "timezone", "time" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "weekly" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" }, "weekdays": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } } }, "required": [ "frequency", "timezone", "time", "weekdays" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "monthly" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" }, "day": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 31 }, { "type": "string", "const": "last" } ] } }, "required": [ "frequency", "timezone", "time", "day" ], "additionalProperties": false } ] }, "start_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)))$" }, "end_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)))$" }, "max_occurrences": { "type": "integer", "minimum": 1, "maximum": 100000 }, "snooze_seconds": { "default": 600, "type": "integer", "minimum": 1, "maximum": 604800 } }, "required": [ "kind", "title", "body", "rule", "snooze_seconds" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "pomodoro" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/listSchedulesResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/listSchedulesResponse/$defs/__schema0" } }, "work_seconds": { "default": 1500, "type": "integer", "minimum": 1, "maximum": 86400 }, "short_break_seconds": { "default": 300, "type": "integer", "minimum": 1, "maximum": 86400 }, "long_break_seconds": { "default": 900, "type": "integer", "minimum": 1, "maximum": 86400 }, "long_break_every": { "default": 4, "type": "integer", "minimum": 1, "maximum": 12 }, "total_cycles": { "default": 4, "type": "integer", "minimum": 1, "maximum": 48 }, "auto_advance": { "default": false, "type": "boolean" } }, "required": [ "kind", "title", "body", "work_seconds", "short_break_seconds", "long_break_seconds", "long_break_every", "total_cycles", "auto_advance" ], "additionalProperties": false } ] }, "status": { "type": "string", "enum": [ "active", "paused", "completed", "cancelled" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "next_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" } ] }, "remaining_seconds": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "phase": { "anyOf": [ { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, { "type": "null" } ] }, "pause_reason": { "anyOf": [ { "type": "string", "enum": [ "user", "stage_end", "capacity" ] }, { "type": "null" } ] }, "completed_cycles": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "occurrence_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "connection_id": { "type": "string" }, "client_type": { "type": "string" }, "current_task_id": { "type": [ "string", "null" ] }, "created_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)))$" }, "updated_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)))$" } }, "required": [ "schedule_id", "kind", "title", "body", "definition", "status", "version", "next_at", "remaining_seconds", "phase", "pause_reason", "completed_cycles", "occurrence_count", "source", "connection_id", "client_type", "current_task_id", "created_at", "updated_at" ], "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/listSchedulesResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/listSchedulesResponse/$defs/__schema0" } } ] } } }, "getScheduleInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getScheduleResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "schedule_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", "enum": [ "recurring", "pomodoro" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "definition": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "recurring" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/getScheduleResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/getScheduleResponse/$defs/__schema0" } }, "rule": { "oneOf": [ { "type": "object", "properties": { "frequency": { "type": "string", "const": "interval" }, "every_seconds": { "type": "integer", "minimum": 60, "maximum": 31536000 } }, "required": [ "frequency", "every_seconds" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "daily" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "frequency", "timezone", "time" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "weekly" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" }, "weekdays": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } } }, "required": [ "frequency", "timezone", "time", "weekdays" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "monthly" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" }, "day": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 31 }, { "type": "string", "const": "last" } ] } }, "required": [ "frequency", "timezone", "time", "day" ], "additionalProperties": false } ] }, "start_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)))$" }, "end_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)))$" }, "max_occurrences": { "type": "integer", "minimum": 1, "maximum": 100000 }, "snooze_seconds": { "default": 600, "type": "integer", "minimum": 1, "maximum": 604800 } }, "required": [ "kind", "title", "body", "rule", "snooze_seconds" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "pomodoro" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/getScheduleResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/getScheduleResponse/$defs/__schema0" } }, "work_seconds": { "default": 1500, "type": "integer", "minimum": 1, "maximum": 86400 }, "short_break_seconds": { "default": 300, "type": "integer", "minimum": 1, "maximum": 86400 }, "long_break_seconds": { "default": 900, "type": "integer", "minimum": 1, "maximum": 86400 }, "long_break_every": { "default": 4, "type": "integer", "minimum": 1, "maximum": 12 }, "total_cycles": { "default": 4, "type": "integer", "minimum": 1, "maximum": 48 }, "auto_advance": { "default": false, "type": "boolean" } }, "required": [ "kind", "title", "body", "work_seconds", "short_break_seconds", "long_break_seconds", "long_break_every", "total_cycles", "auto_advance" ], "additionalProperties": false } ] }, "status": { "type": "string", "enum": [ "active", "paused", "completed", "cancelled" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "next_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" } ] }, "remaining_seconds": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "phase": { "anyOf": [ { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, { "type": "null" } ] }, "pause_reason": { "anyOf": [ { "type": "string", "enum": [ "user", "stage_end", "capacity" ] }, { "type": "null" } ] }, "completed_cycles": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "occurrence_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "connection_id": { "type": "string" }, "client_type": { "type": "string" }, "current_task_id": { "type": [ "string", "null" ] }, "created_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)))$" }, "updated_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)))$" } }, "required": [ "schedule_id", "kind", "title", "body", "definition", "status", "version", "next_at", "remaining_seconds", "phase", "pause_reason", "completed_cycles", "occurrence_count", "source", "connection_id", "client_type", "current_task_id", "created_at", "updated_at" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/getScheduleResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/getScheduleResponse/$defs/__schema0" } } ] } } }, "updateScheduleInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "body": { "type": "object", "properties": { "definition": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "recurring" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/updateScheduleInput/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/updateScheduleInput/$defs/__schema0" } }, "rule": { "oneOf": [ { "type": "object", "properties": { "frequency": { "type": "string", "const": "interval" }, "every_seconds": { "type": "integer", "minimum": 60, "maximum": 31536000 } }, "required": [ "frequency", "every_seconds" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "daily" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "frequency", "timezone", "time" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "weekly" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" }, "weekdays": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } } }, "required": [ "frequency", "timezone", "time", "weekdays" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "monthly" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" }, "day": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 31 }, { "type": "string", "const": "last" } ] } }, "required": [ "frequency", "timezone", "time", "day" ], "additionalProperties": false } ] }, "start_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)))$" }, "end_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)))$" }, "max_occurrences": { "type": "integer", "minimum": 1, "maximum": 100000 }, "snooze_seconds": { "default": 600, "type": "integer", "minimum": 1, "maximum": 604800 } }, "required": [ "kind", "title", "rule" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "pomodoro" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/updateScheduleInput/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/updateScheduleInput/$defs/__schema0" } }, "work_seconds": { "default": 1500, "type": "integer", "minimum": 1, "maximum": 86400 }, "short_break_seconds": { "default": 300, "type": "integer", "minimum": 1, "maximum": 86400 }, "long_break_seconds": { "default": 900, "type": "integer", "minimum": 1, "maximum": 86400 }, "long_break_every": { "default": 4, "type": "integer", "minimum": 1, "maximum": 12 }, "total_cycles": { "default": 4, "type": "integer", "minimum": 1, "maximum": 48 }, "auto_advance": { "default": false, "type": "boolean" } }, "required": [ "kind", "title" ], "additionalProperties": false } ] }, "expected_version": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "idempotency_key": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[\\w.-]+$" } }, "required": [ "definition", "expected_version", "idempotency_key" ], "additionalProperties": false } }, "required": [ "params", "body" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/updateScheduleInput/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/updateScheduleInput/$defs/__schema0" } } ] } } }, "updateScheduleResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "schedule_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", "enum": [ "recurring", "pomodoro" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "definition": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "recurring" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/updateScheduleResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/updateScheduleResponse/$defs/__schema0" } }, "rule": { "oneOf": [ { "type": "object", "properties": { "frequency": { "type": "string", "const": "interval" }, "every_seconds": { "type": "integer", "minimum": 60, "maximum": 31536000 } }, "required": [ "frequency", "every_seconds" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "daily" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "frequency", "timezone", "time" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "weekly" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" }, "weekdays": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } } }, "required": [ "frequency", "timezone", "time", "weekdays" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "monthly" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" }, "day": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 31 }, { "type": "string", "const": "last" } ] } }, "required": [ "frequency", "timezone", "time", "day" ], "additionalProperties": false } ] }, "start_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)))$" }, "end_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)))$" }, "max_occurrences": { "type": "integer", "minimum": 1, "maximum": 100000 }, "snooze_seconds": { "default": 600, "type": "integer", "minimum": 1, "maximum": 604800 } }, "required": [ "kind", "title", "body", "rule", "snooze_seconds" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "pomodoro" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/updateScheduleResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/updateScheduleResponse/$defs/__schema0" } }, "work_seconds": { "default": 1500, "type": "integer", "minimum": 1, "maximum": 86400 }, "short_break_seconds": { "default": 300, "type": "integer", "minimum": 1, "maximum": 86400 }, "long_break_seconds": { "default": 900, "type": "integer", "minimum": 1, "maximum": 86400 }, "long_break_every": { "default": 4, "type": "integer", "minimum": 1, "maximum": 12 }, "total_cycles": { "default": 4, "type": "integer", "minimum": 1, "maximum": 48 }, "auto_advance": { "default": false, "type": "boolean" } }, "required": [ "kind", "title", "body", "work_seconds", "short_break_seconds", "long_break_seconds", "long_break_every", "total_cycles", "auto_advance" ], "additionalProperties": false } ] }, "status": { "type": "string", "enum": [ "active", "paused", "completed", "cancelled" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "next_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" } ] }, "remaining_seconds": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "phase": { "anyOf": [ { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, { "type": "null" } ] }, "pause_reason": { "anyOf": [ { "type": "string", "enum": [ "user", "stage_end", "capacity" ] }, { "type": "null" } ] }, "completed_cycles": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "occurrence_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "connection_id": { "type": "string" }, "client_type": { "type": "string" }, "current_task_id": { "type": [ "string", "null" ] }, "created_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)))$" }, "updated_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)))$" } }, "required": [ "schedule_id", "kind", "title", "body", "definition", "status", "version", "next_at", "remaining_seconds", "phase", "pause_reason", "completed_cycles", "occurrence_count", "source", "connection_id", "client_type", "current_task_id", "created_at", "updated_at" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/updateScheduleResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/updateScheduleResponse/$defs/__schema0" } } ] } } }, "controlScheduleInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "body": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "pause", "resume", "cancel", "skip" ] }, "expected_version": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "idempotency_key": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[\\w.-]+$" } }, "required": [ "action", "expected_version", "idempotency_key" ], "additionalProperties": false } }, "required": [ "params", "body" ], "additionalProperties": false }, "controlScheduleResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "schedule_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", "enum": [ "recurring", "pomodoro" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "definition": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "recurring" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/controlScheduleResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/controlScheduleResponse/$defs/__schema0" } }, "rule": { "oneOf": [ { "type": "object", "properties": { "frequency": { "type": "string", "const": "interval" }, "every_seconds": { "type": "integer", "minimum": 60, "maximum": 31536000 } }, "required": [ "frequency", "every_seconds" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "daily" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "frequency", "timezone", "time" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "weekly" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" }, "weekdays": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } } }, "required": [ "frequency", "timezone", "time", "weekdays" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "monthly" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" }, "day": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 31 }, { "type": "string", "const": "last" } ] } }, "required": [ "frequency", "timezone", "time", "day" ], "additionalProperties": false } ] }, "start_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)))$" }, "end_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)))$" }, "max_occurrences": { "type": "integer", "minimum": 1, "maximum": 100000 }, "snooze_seconds": { "default": 600, "type": "integer", "minimum": 1, "maximum": 604800 } }, "required": [ "kind", "title", "body", "rule", "snooze_seconds" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "pomodoro" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/controlScheduleResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/controlScheduleResponse/$defs/__schema0" } }, "work_seconds": { "default": 1500, "type": "integer", "minimum": 1, "maximum": 86400 }, "short_break_seconds": { "default": 300, "type": "integer", "minimum": 1, "maximum": 86400 }, "long_break_seconds": { "default": 900, "type": "integer", "minimum": 1, "maximum": 86400 }, "long_break_every": { "default": 4, "type": "integer", "minimum": 1, "maximum": 12 }, "total_cycles": { "default": 4, "type": "integer", "minimum": 1, "maximum": 48 }, "auto_advance": { "default": false, "type": "boolean" } }, "required": [ "kind", "title", "body", "work_seconds", "short_break_seconds", "long_break_seconds", "long_break_every", "total_cycles", "auto_advance" ], "additionalProperties": false } ] }, "status": { "type": "string", "enum": [ "active", "paused", "completed", "cancelled" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "next_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" } ] }, "remaining_seconds": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "phase": { "anyOf": [ { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, { "type": "null" } ] }, "pause_reason": { "anyOf": [ { "type": "string", "enum": [ "user", "stage_end", "capacity" ] }, { "type": "null" } ] }, "completed_cycles": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "occurrence_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "connection_id": { "type": "string" }, "client_type": { "type": "string" }, "current_task_id": { "type": [ "string", "null" ] }, "created_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)))$" }, "updated_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)))$" } }, "required": [ "schedule_id", "kind", "title", "body", "definition", "status", "version", "next_at", "remaining_seconds", "phase", "pause_reason", "completed_cycles", "occurrence_count", "source", "connection_id", "client_type", "current_task_id", "created_at", "updated_at" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/controlScheduleResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/controlScheduleResponse/$defs/__schema0" } } ] } } }, "scheduleHistoryInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false }, "query": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "scheduleHistoryResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "id": { "type": "string" }, "event": { "type": "string" }, "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)))$" }, "request_id": { "type": "string" }, "actor_connection_id": { "type": "string" }, "task_id": { "type": "string" }, "late_by_ms": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "snapshot": { "type": "object", "properties": { "schedule_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", "enum": [ "recurring", "pomodoro" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "definition": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "recurring" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/scheduleHistoryResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/scheduleHistoryResponse/$defs/__schema0" } }, "rule": { "oneOf": [ { "type": "object", "properties": { "frequency": { "type": "string", "const": "interval" }, "every_seconds": { "type": "integer", "minimum": 60, "maximum": 31536000 } }, "required": [ "frequency", "every_seconds" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "daily" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "frequency", "timezone", "time" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "weekly" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" }, "weekdays": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 } } }, "required": [ "frequency", "timezone", "time", "weekdays" ], "additionalProperties": false }, { "type": "object", "properties": { "frequency": { "type": "string", "const": "monthly" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$" }, "day": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 31 }, { "type": "string", "const": "last" } ] } }, "required": [ "frequency", "timezone", "time", "day" ], "additionalProperties": false } ] }, "start_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)))$" }, "end_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)))$" }, "max_occurrences": { "type": "integer", "minimum": 1, "maximum": 100000 }, "snooze_seconds": { "default": 600, "type": "integer", "minimum": 1, "maximum": 604800 } }, "required": [ "kind", "title", "body", "rule", "snooze_seconds" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "pomodoro" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "body": { "default": "", "type": "string", "maxLength": 4000 }, "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/scheduleHistoryResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/scheduleHistoryResponse/$defs/__schema0" } }, "work_seconds": { "default": 1500, "type": "integer", "minimum": 1, "maximum": 86400 }, "short_break_seconds": { "default": 300, "type": "integer", "minimum": 1, "maximum": 86400 }, "long_break_seconds": { "default": 900, "type": "integer", "minimum": 1, "maximum": 86400 }, "long_break_every": { "default": 4, "type": "integer", "minimum": 1, "maximum": 12 }, "total_cycles": { "default": 4, "type": "integer", "minimum": 1, "maximum": 48 }, "auto_advance": { "default": false, "type": "boolean" } }, "required": [ "kind", "title", "body", "work_seconds", "short_break_seconds", "long_break_seconds", "long_break_every", "total_cycles", "auto_advance" ], "additionalProperties": false } ] }, "status": { "type": "string", "enum": [ "active", "paused", "completed", "cancelled" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "next_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" } ] }, "remaining_seconds": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "phase": { "anyOf": [ { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, { "type": "null" } ] }, "pause_reason": { "anyOf": [ { "type": "string", "enum": [ "user", "stage_end", "capacity" ] }, { "type": "null" } ] }, "completed_cycles": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "occurrence_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "connection_id": { "type": "string" }, "client_type": { "type": "string" }, "current_task_id": { "type": [ "string", "null" ] }, "created_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)))$" }, "updated_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)))$" } }, "required": [ "schedule_id", "kind", "title", "body", "definition", "status", "version", "next_at", "remaining_seconds", "phase", "pause_reason", "completed_cycles", "occurrence_count", "source", "connection_id", "client_type", "current_task_id", "created_at", "updated_at" ], "additionalProperties": {} } }, "required": [ "sequence", "id", "event", "at", "request_id", "actor_connection_id", "late_by_ms", "snapshot" ], "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": {}, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/scheduleHistoryResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/scheduleHistoryResponse/$defs/__schema0" } } ] } } }, "reportSessionInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "body": { "type": "object", "properties": { "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "maxLength": 128 }, "agent_name": { "type": "string", "minLength": 1, "maxLength": 100 }, "status": { "type": "string", "enum": [ "active", "idle", "errored" ] }, "last_action": { "type": "string", "maxLength": 200 }, "task_title": { "type": "string", "maxLength": 200 }, "capture": { "type": "object", "properties": { "task_titles": { "type": "boolean" }, "receipts": { "type": "boolean" }, "cost_tracking": { "type": "boolean" }, "transcripts": { "type": "boolean" } }, "required": [ "task_titles", "receipts", "cost_tracking", "transcripts" ], "additionalProperties": false }, "capabilities": { "type": "object", "properties": { "spawn": { "type": "boolean" }, "providers": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 40 }, "version": { "type": "string", "maxLength": 60 }, "path": { "type": "string", "maxLength": 400 } }, "required": [ "name" ], "additionalProperties": false } }, "config": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 40 }, "additionalProperties": { "type": "string", "maxLength": 400 } } }, "required": [ "spawn", "providers" ], "additionalProperties": false } }, "required": [ "session_id" ], "additionalProperties": false } }, "required": [ "body" ], "additionalProperties": false }, "reportSessionResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": {} }, "listSessionsInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "query": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "active", "idle", "waiting", "offline", "errored" ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "additionalProperties": false } }, "additionalProperties": false }, "listSessionsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "machine_id": { "type": "string" }, "agent_name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "idle", "waiting", "offline", "errored" ] }, "last_action": { "type": "string" }, "last_seen_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)))$" }, "pending_task_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)$" } }, "task_title": { "type": "string" }, "capture": { "type": "object", "properties": { "task_titles": { "type": "boolean" }, "receipts": { "type": "boolean" }, "cost_tracking": { "type": "boolean" }, "transcripts": { "type": "boolean" } }, "required": [ "task_titles", "receipts", "cost_tracking", "transcripts" ], "additionalProperties": false } }, "required": [ "connection_id", "session_id", "machine_id", "agent_name", "status", "last_action", "last_seen_at", "pending_task_ids" ], "additionalProperties": {} } } }, "required": [ "items" ], "additionalProperties": {} }, "listRecipientsInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "query": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 4096 }, "status": { "type": "string", "enum": [ "invited", "active", "revoked" ] }, "external_id": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "listRecipientsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "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)$" }, "name": { "type": "string" }, "external_id": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "invited", "active", "revoked" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "email_restricted": { "type": "boolean" }, "invite_expires_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)))$" }, "joined_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" } ] }, "created_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)))$" }, "updated_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)))$" } }, "required": [ "id", "name", "external_id", "tags", "status", "version", "email_restricted", "invite_expires_at", "joined_at", "created_at", "updated_at" ], "additionalProperties": {} } }, "next_cursor": { "type": "string" } }, "required": [ "items" ], "additionalProperties": {} }, "getRecipientInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "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)$" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "params" ], "additionalProperties": false }, "getRecipientResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "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)$" }, "name": { "type": "string" }, "external_id": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "invited", "active", "revoked" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "email_restricted": { "type": "boolean" }, "invite_expires_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)))$" }, "joined_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" } ] }, "created_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)))$" }, "updated_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)))$" } }, "required": [ "id", "name", "external_id", "tags", "status", "version", "email_restricted", "invite_expires_at", "joined_at", "created_at", "updated_at" ], "additionalProperties": {} }, "queryAuditInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "query": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 200 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 4096 }, "scope": { "type": "string", "enum": [ "all", "task", "account", "schedule", "recipient", "authorization" ] }, "recipient_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)$" }, "schedule_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)$" }, "task_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)$" }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "machine_id": { "type": "string" }, "agent_type": { "type": "string" }, "decision": { "type": "string" }, "event": { "type": "string" }, "q": { "type": "string", "maxLength": 1000 }, "from": { "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": "string", "format": "date", "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])))$" } ] }, "to": { "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": "string", "format": "date", "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])))$" } ] } }, "additionalProperties": false } }, "additionalProperties": false }, "queryAuditResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "scope": { "type": "string", "enum": [ "task", "account", "schedule", "recipient", "authorization" ] }, "recipient_id": { "type": [ "string", "null" ] }, "schedule_id": { "type": [ "string", "null" ] }, "event": { "type": "string" }, "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)))$" }, "request_id": { "type": "string" }, "task_id": { "type": [ "string", "null" ] }, "entity_id": { "type": "string" }, "connection_id": { "type": [ "string", "null" ] }, "source": { "type": "string" }, "agent_name": { "type": "string" }, "agent_type": { "type": "string" }, "session_id": { "type": [ "string", "null" ] }, "machine_id": { "type": [ "string", "null" ] }, "tool_name": { "type": [ "string", "null" ] }, "kind": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "decision": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "answer": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "detail": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "id", "scope", "event", "at", "request_id", "task_id", "entity_id", "connection_id", "source", "agent_name", "agent_type", "session_id", "machine_id", "tool_name", "kind", "status", "decision", "content", "answer", "detail" ], "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": {} }, "listWebhookDeliveriesInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "query": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 4096 }, "task_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 } }, "additionalProperties": false }, "listWebhookDeliveriesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "task_id": { "type": "string" }, "event_id": { "type": "string" }, "channel_id": { "type": "string" }, "webhook_id": { "type": "string" }, "secret_scope": { "type": "string" }, "kind": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "leased", "retry", "accepted", "failed", "suppressed" ] }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max_attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "error_code": { "type": [ "string", "null" ] }, "http_status": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "signing_version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "created_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)))$" }, "updated_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)))$" }, "update_status": { "type": "string" } }, "required": [ "id", "task_id", "event_id", "channel_id", "kind", "status", "attempts", "max_attempts", "error_code", "http_status", "created_at", "updated_at" ], "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": {} }, "waitForDecisionInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "params": { "type": "object", "properties": { "decisionId": { "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)$" } }, "required": [ "decisionId" ], "additionalProperties": false }, "body": { "type": "object", "properties": { "timeout_seconds": { "type": "integer", "minimum": 1, "maximum": 25 } }, "additionalProperties": false } }, "required": [ "params", "body" ], "additionalProperties": false }, "waitForDecisionResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "type": "object", "properties": { "decision_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)$" }, "task": { "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/waitForDecisionResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/waitForDecisionResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {} }, "approval_url": { "type": "string" }, "idempotent": { "type": "boolean" }, "availability": { "type": "object", "properties": { "web_endpoints": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "email_channels": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "slack_connections": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "web_endpoints", "email_channels", "slack_connections" ], "additionalProperties": {} }, "status": { "type": "string", "const": "answered" }, "answered": { "type": "boolean", "const": true }, "value": { "type": "string" } }, "required": [ "decision_id", "task", "idempotent", "availability", "status", "answered", "value" ], "additionalProperties": {} }, { "type": "object", "properties": { "decision_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)$" }, "task": { "type": "object", "properties": { "subject": { "type": "object", "properties": { "actor": { "type": "string", "maxLength": 120 }, "environment": { "type": "string", "maxLength": 40 } }, "additionalProperties": false }, "webhook_ids": { "minItems": 1, "maxItems": 5, "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)$" } }, "content": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "type": { "type": "string", "enum": [ "info", "task_complete", "error" ] }, "summary": { "type": "string", "maxLength": 2000 }, "details": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } }, "files_changed": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 500 } }, "error_message": { "type": "string", "maxLength": 4000 }, "error_file": { "type": "string", "maxLength": 500 }, "next_steps": { "type": "string", "maxLength": 2000 }, "links": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "label", "url" ], "additionalProperties": false } }, "image_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "icon_url": { "type": "string", "maxLength": 2048, "format": "uri" }, "url": { "type": "string", "maxLength": 2048, "format": "uri" }, "click_action": { "type": "string", "enum": [ "detail", "url" ] } }, "additionalProperties": false }, "presentation": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "effect": { "type": "string", "minLength": 1, "maxLength": 200 }, "risk": { "type": "string", "maxLength": 200 }, "changes": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "minLength": 1, "maxLength": 80 }, "label": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "kind", "currency" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "quantity" }, "unit": { "type": "string", "maxLength": 16 } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "timestamp" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "boolean" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "parameter", "label", "format" ], "additionalProperties": false } } }, "required": [ "label", "effect" ], "additionalProperties": false }, "parameters": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number" }, { "type": "boolean" } ] } }, "origin": { "type": "object", "properties": { "agent_name": { "type": "string", "maxLength": 100 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "machine_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool_name": { "type": "string", "maxLength": 100 }, "tool_target": { "type": "string", "maxLength": 200 }, "repo_key": { "type": "string", "maxLength": 200 }, "intent": { "type": "string", "maxLength": 500 }, "action": { "type": "string", "maxLength": 500 }, "blocker": { "type": "string", "maxLength": 500 }, "action_body": { "type": "string", "maxLength": 4000 } }, "additionalProperties": false }, "audience": { "type": "object", "properties": { "recipients": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "device_ids": { "minItems": 1, "maxItems": 100, "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)$" } }, "external_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "tags": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 60 } }, "tag_match": { "type": "string", "enum": [ "any", "all" ] } }, "additionalProperties": false }, "delivery": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ], "description": "live (default) delivers to devices. test rehearses: the card is created and shown as a rehearsal, never delivered to devices, never counted as activity or used for rule suggestions. Different from the public /try sandbox, which runs on its own throwaway account." }, "channels": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "web_push", "email", "slack", "native" ] } }, "urgency": { "type": "string", "enum": [ "very-low", "low", "normal", "high" ] }, "ttl_seconds": { "type": "integer", "minimum": 0, "maximum": 2419200 }, "require_reachable": { "type": "boolean" } }, "additionalProperties": false }, "data": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/waitForDecisionResponse/$defs/__schema0" } }, "metadata": { "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "$ref": "#/components/schemas/waitForDecisionResponse/$defs/__schema0" } }, "task_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)$" }, "occurrence_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", "enum": [ "notification", "reminder", "question", "device_test" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "pending", "read", "completed", "answered", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string" }, "created_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)))$" }, "due_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)))$" }, "expires_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" } ] }, "detail_path": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": {} } }, "response": { "anyOf": [ { "type": "object", "properties": { "action_id": { "type": "string" }, "label": { "type": "string" }, "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)))$" }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "other": { "type": "string" }, "note": { "type": "string" }, "respondent": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "agent", "recipient", "link" ] }, "user_id": { "type": [ "string", "null" ] }, "connection_id": { "type": "string" }, "session_id": { "type": "string" }, "recipient_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "api", "slack" ] }, "channel_id": { "type": "string" }, "platform_user_id": { "type": "string" }, "via": { "type": "string", "enum": [ "backend", "approval_link" ] }, "external_id": { "type": "string" } }, "required": [ "kind", "user_id", "connection_id", "channel" ], "additionalProperties": {} } }, "required": [ "action_id", "label", "at" ], "additionalProperties": {} }, { "type": "null" } ] }, "interaction": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "type": { "type": "string", "enum": [ "confirm", "select", "input" ] }, "header": { "type": "string", "maxLength": 80 }, "options": { "minItems": 2, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "allow_other": { "type": "boolean" }, "allow_note": { "type": "boolean" }, "placeholder": { "type": "string", "maxLength": 200 }, "min_length": { "type": "integer", "minimum": 1, "maximum": 4000 }, "max_length": { "type": "integer", "minimum": 1, "maximum": 4000 } }, "required": [ "question", "type" ], "additionalProperties": false }, "card_version": { "type": "number", "const": 1 }, "powered_by": { "type": "boolean" }, "schedule": { "type": "object", "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)$" }, "occurrence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "phase": { "type": "string", "enum": [ "work", "short_break", "long_break" ] }, "scheduled_for": { "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)))$" } }, "required": [ "id", "occurrence", "scheduled_for" ], "additionalProperties": {} }, "device_id": { "type": [ "string", "null" ] }, "can_respond": { "type": "boolean" }, "updated_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)))$" }, "delivery_failed": { "type": "boolean" } }, "required": [ "task_id", "occurrence_id", "kind", "title", "body", "status", "version", "source", "created_at", "due_at", "expires_at", "detail_path", "actions", "response", "device_id", "updated_at" ], "additionalProperties": {} }, "approval_url": { "type": "string" }, "idempotent": { "type": "boolean" }, "availability": { "type": "object", "properties": { "web_endpoints": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "email_channels": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "slack_connections": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "web_endpoints", "email_channels", "slack_connections" ], "additionalProperties": {} }, "status": { "type": "string", "enum": [ "pending", "cancelled", "expired" ] }, "answered": { "type": "boolean", "const": false }, "value": { "type": "null" } }, "required": [ "decision_id", "task", "idempotent", "availability", "status", "answered", "value" ], "additionalProperties": {} }, { "type": "object", "properties": { "status": { "type": "string", "const": "stopped" }, "answered": { "type": "boolean", "const": false }, "value": { "type": "null" }, "idempotent": { "type": "boolean" }, "stopped": { "type": "object", "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)$" }, "site_epoch": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "session_epoch": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "type": "string", "enum": [ "site", "session" ] } }, "required": [ "id", "site_epoch", "session_epoch", "scope" ], "additionalProperties": {} } }, "required": [ "status", "answered", "value", "idempotent", "stopped" ], "additionalProperties": {} } ], "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/waitForDecisionResponse/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/waitForDecisionResponse/$defs/__schema0" } } ] } } }, "healthInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {}, "additionalProperties": false }, "healthResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean" }, "client_contract_version": { "type": "string" }, "app_origin": { "type": "string" } }, "required": [ "ok", "client_contract_version", "app_origin" ], "additionalProperties": {} } } } }