{ "openapi": "3.0.1", "info": { "title": "Zendesk Help Center Article Sync", "description": "Sync Apify Dataset items into Zendesk Guide (Help Center) as articles. Create or update articles using templates (Handlebars) for title/body, validate locales, and keep your knowledge base continuously up to date for self-service, agents, and chatbot workflows.", "version": "0.0", "x-build-id": "HIm9hvchBeEihcfdK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/joshua20226~zendesk-help-center-article-sync/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-joshua20226-zendesk-help-center-article-sync", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/joshua20226~zendesk-help-center-article-sync/runs": { "post": { "operationId": "runs-sync-joshua20226-zendesk-help-center-article-sync", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/joshua20226~zendesk-help-center-article-sync/run-sync": { "post": { "operationId": "run-sync-joshua20226-zendesk-help-center-article-sync", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "datasetId", "zendesk_api_token", "zendesk_auth" ], "properties": { "datasetId": { "title": "Source dataset", "type": "string", "description": "Select the Apify Dataset that contains the source items to publish to Zendesk." }, "zendesk_api_token": { "title": "Zendesk API token", "type": "string", "description": "Zendesk API token (stored encrypted)." }, "zendesk_auth": { "title": "Zendesk Auth", "required": [ "subdomain", "user_segment_id", "permission_group_id", "email" ], "type": "object", "description": "Zendesk subdomain and credentials used to call the Help Center API.", "properties": { "subdomain": { "title": "Zendesk subdomain", "type": "string", "description": "Your Zendesk subdomain (e.g. 'acme' for https://acme.zendesk.com).", "editor": "textfield", "minLength": 1 }, "user_segment_id": { "title": "User segment ID", "type": "string", "description": "Your Zendesk User segment Id, required to create/update articles.", "editor": "textfield" }, "permission_group_id": { "title": "Permission group ID", "type": "string", "description": "Your Zendesk Permission group ID, required to create/update articles.", "editor": "textfield" }, "email": { "title": "Zendesk admin email", "type": "string", "description": "Zendesk email used with the API token.", "editor": "textfield", "minLength": 3 } }, "additionalProperties": false }, "defaultSectionId": { "title": "Zendesk section ID", "type": "string", "description": "Zendesk Help Center section ID" }, "defaultLocale": { "title": "Default locale", "type": "string", "description": "Default Zendesk locale used when an item does not specify one (e.g. en-us).", "default": "en-gb" }, "defaultTitle": { "title": "Default title", "type": "string", "description": "Fallback title if you don't have a titleTemplate. (e.g. Imported Article)" }, "titleTemplate": { "title": "Title template", "type": "string", "description": "Template used to render an article title from each dataset item (e.g. {{title}} - {{created}})." }, "bodyTemplate": { "title": "Body template (HTML)", "type": "string", "description": "Template used to render the article body from each dataset item. Provide HTML (e.g.

{{content}}

)." }, "publishMode": { "title": "Publish mode", "enum": [ "draft", "published" ], "type": "string", "description": "Whether to create/update articles as drafts or published.", "default": "draft" }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Safety cap for how many dataset items to process in one run." }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of parallel workers for publishing articles.", "default": 3 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }