Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zendesk Channel Framework API

The Channel Framework API from Zendesk — 3 operation(s) for channel framework.

Zendesk Channel Framework API is one of 150 APIs that Zendesk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Channel Framework. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against the base URL https://{subdomain}.zendesk.com.

3 operations 3 paths 1 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://{subdomain}.zendesk.com
Resource Areas
1

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Channel Framework 3
POST
/api/v2/any_channel/channelback/report_error
Zendesk Post Api V2 Anychannel Channelback Reporterror
ReportChannelbackError → 200
POST
/api/v2/any_channel/push
Zendesk Post Api V2 Anychannel Push
PushContentToSupport → 200
POST
/api/v2/any_channel/validate_token
Zendesk Post Api V2 Anychannel Validatetoken
ValidateToken → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ChannelFrameworkPushResultsResponse (1 property). Each schema is shown below with its type and property counts.

ChannelFrameworkPushResultsResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zendesk-channel-framework-api-openapi.yml Raw ↑

Other APIs Zendesk publishes across the network.

Zendesk Help Center Articles API
Zendesk Help Center Sections API
Zendesk Help Center Categories API
Zendesk Help Center Translations API
Zendesk Help Center Article Attachments API
Zendesk Help Center Article Comments API
Zendesk Help Center Article Labels API
Zendesk Help Center Topics API
Zendesk Help Center Posts API
Zendesk Help Center Post Comments API
Zendesk Help Center Votes API
Zendesk Help Center Content Subscriptions API