How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

8x8 Workflow Definition Management API

The Workflow Definition Management API from 8x8 — 3 operation(s) for workflow definition management.

8x8 Workflow Definition Management API is one of 71 APIs that 8x8 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workflow Definition Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://automation.8x8.com.

6 operations 3 paths 14 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.8x8.com
Authentication
HTTP Bearer
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

8x8 Workflow Definition Management API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Workflow Definition Management 6
GET
/api/v1/accounts/{accountId}/definitions
Retrieve a list of active workflow definitions.
get-all-definitions 3 params → 200
POST
/api/v1/accounts/{accountId}/definitions
Create a new workflow definition
create-definition 1 param body → 201400
GET
/api/v1/accounts/{accountId}/definitions/{definitionId}
Retrieve the version history of a workflow definition.
get-specific-definition 4 params → 200400
PUT
/api/v1/accounts/{accountId}/definitions/{definitionId}
Update workflow definition
update-existing-definition 2 params body → 200400404
DELETE
/api/v1/accounts/{accountId}/definitions/{definitionId}
Delete workflow definition
delete-definitions 3 params → 202400404
POST
/api/v1/accounts/{accountId}/definitions/{definitionId}/workflows
Test workflow definition
start-workflow-instance 3 params body → 201400404

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are waitForReplyStep (5 properties), httpRequestStep (4 properties), smsStep (4 properties), waitForDTMFStep (4 properties). Each schema is shown below with its type and property counts.

waitForDTMFStep
object
Step to make the workflow wait for a DTMF response from an end-user.
4 properties 3 required
status
string
The status property allows to deactivate an existing workflow definition or to save a new one, without making it active. enabled (this workflow definition is a…
step
object
Step defines an activity to be performed when the workflow is running.
1 property 1 required
waitForReplyStep
object
Step to make the workflow wait for a reply from an end-user.
5 properties 3 required
chatAppsMessageStep
object
Step to send a chat apps message.
4 properties 2 required
error
object
Error response.
4 properties 4 required
definition
voiceMessageStep
object
Step to make the workflow wait for a reply from an end-user.
4 properties 2 required
smsStep
object
Step to send a SMS.
4 properties
httpRequestStep
object
Step to make a HTTP request.
4 properties 2 required
trigger
string
Triggers are external events that start workflows. Supported triggers are inboundsms (starts workflows when the account receives a SMS.) inboundchatapps (start…
definitionInput
object
4 properties 3 required
branchStep
object
Step to dynamically create branches in the workflow.
2 properties 2 required
waitStep
object
Step to make the workflow pause for a specified duration.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

8x8-workflow-definition-management-api-openapi.yml Raw ↑

Other APIs 8x8 publishes across the network.

8x8 Event Streaming API
Jitsi as a Service (JaaS)
8x8 CPaaS Voice Webhooks
8x8 Addresses API
8x8 Agent Activity API
8x8 Agent status API
8x8 Agents API
8x8 Analytics API
8x8 Attachments API
8x8 Audit API
8x8 Authentication API
8x8 Batch API
Where this information came from

This is an independent, third-party profile of 8x8 Workflow Definition Management API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.